1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00

formatting

This commit is contained in:
Kelly Brazil
2022-01-19 21:32:21 -08:00
parent f355333eee
commit 583a5757e4
18 changed files with 34 additions and 30 deletions

View File

@ -108,7 +108,7 @@ Schema:
} }
] ]
[0] naive timestamp if when field is parsable, else null [0] naive timestamp if "when" field is parsable, else null
[1] timezone aware timestamp availabe for UTC, else null [1] timezone aware timestamp availabe for UTC, else null
Examples: Examples:

View File

@ -29,7 +29,7 @@ Schema:
"type": integer, "type": integer,
"bytes": integer, "bytes": integer,
"description": string, "description": string,
"values": { (null if empty) "values": { # null if empty
"lowercase_no_spaces_keys": string, "lowercase_no_spaces_keys": string,
"multiline_key_values": [ "multiline_key_values": [
string, string,

View File

@ -26,7 +26,7 @@ Schema:
[ [
{ {
"filename": string, "filename": string,
"type ": string "type": string
} }
] ]

View File

@ -37,9 +37,9 @@ Schema:
"login": string, "login": string,
"logout": string, "logout": string,
"duration": string, "duration": string,
"login_epoch": integer, # (naive) available with last -F option "login_epoch": integer, # (naive) available w/last -F option
"logout_epoch": integer, # (naive) available with last -F option "logout_epoch": integer, # (naive) available w/last -F option
"duration_seconds": integer # available with last -F option "duration_seconds": integer # available w/last -F option
} }
] ]

View File

@ -54,8 +54,9 @@ Schema:
} }
] ]
[0] naive timestamp if date field exists and can be converted [0] naive timestamp if date field exists and can be converted.
[1] timezone aware timestamp if date field is in UTC and can be converted [1] timezone aware timestamp if date field is in UTC and can
be converted.
Examples: Examples:

View File

@ -12,8 +12,8 @@ in the filename, then make sure to use the `-b` option on `ls`.
The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames
with newline characters, but `-b` was not used) with newline characters, but `-b` was not used)
The `epoch` calculated timestamp field is naive (i.e. based on the local time The `epoch` calculated timestamp field is naive (i.e. based on the local
of the system the parser is run on) time of the system the parser is run on)
The `epoch_utc` calculated timestamp field is timezone-aware and is only The `epoch_utc` calculated timestamp field is timezone-aware and is only
available if the timezone field is UTC. available if the timezone field is UTC.
@ -62,8 +62,9 @@ Schema:
} }
} }
[0] naive timestamp if date field exists and can be converted [0] naive timestamp if date field exists and can be converted.
[1] timezone aware timestamp if date field is in UTC and can be converted [1] timezone aware timestamp if date field is in UTC and can
be converted
Examples: Examples:

View File

@ -15,7 +15,7 @@ Usage (cli):
appear the output is hanging due to the OS pipe buffers. This is because appear the output is hanging due to the OS pipe buffers. This is because
`ping` output is too small to quickly fill up the buffer. Use the `-u` `ping` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. option to unbuffer the `jc` output if you would like immediate output.
See the[readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. for more information.
Usage (module): Usage (module):

View File

@ -10,7 +10,7 @@ Note: On some operating systems you will need to redirect `STDERR` to
`STDERR`. A warning message will be printed to `STDERR` if the `STDERR`. A warning message will be printed to `STDERR` if the
header row is not found. header row is not found.
e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
Usage (cli): Usage (cli):

View File

@ -41,7 +41,7 @@ Schema:
], ],
"tcp_ranges": [ "tcp_ranges": [
{ {
"start": integer, # 'any' is converted to start/end: 0/65535 "start": integer, # [0]
"end": integer "end": integer
} }
], ],

View File

@ -105,7 +105,7 @@ Schema:
} }
] ]
[0] naive timestamp if when field is parsable, else null [0] naive timestamp if "when" field is parsable, else null
[1] timezone aware timestamp availabe for UTC, else null [1] timezone aware timestamp availabe for UTC, else null
Examples: Examples:

View File

@ -26,7 +26,7 @@ Schema:
"type": integer, "type": integer,
"bytes": integer, "bytes": integer,
"description": string, "description": string,
"values": { (null if empty) "values": { # null if empty
"lowercase_no_spaces_keys": string, "lowercase_no_spaces_keys": string,
"multiline_key_values": [ "multiline_key_values": [
string, string,

View File

@ -23,7 +23,7 @@ Schema:
[ [
{ {
"filename": string, "filename": string,
"type ": string "type": string
} }
] ]

View File

@ -34,9 +34,9 @@ Schema:
"login": string, "login": string,
"logout": string, "logout": string,
"duration": string, "duration": string,
"login_epoch": integer, # (naive) available with last -F option "login_epoch": integer, # (naive) available w/last -F option
"logout_epoch": integer, # (naive) available with last -F option "logout_epoch": integer, # (naive) available w/last -F option
"duration_seconds": integer # available with last -F option "duration_seconds": integer # available w/last -F option
} }
] ]

View File

@ -51,8 +51,9 @@ Schema:
} }
] ]
[0] naive timestamp if date field exists and can be converted [0] naive timestamp if date field exists and can be converted.
[1] timezone aware timestamp if date field is in UTC and can be converted [1] timezone aware timestamp if date field is in UTC and can
be converted.
Examples: Examples:

View File

@ -9,8 +9,8 @@ in the filename, then make sure to use the `-b` option on `ls`.
The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames
with newline characters, but `-b` was not used) with newline characters, but `-b` was not used)
The `epoch` calculated timestamp field is naive (i.e. based on the local time The `epoch` calculated timestamp field is naive (i.e. based on the local
of the system the parser is run on) time of the system the parser is run on)
The `epoch_utc` calculated timestamp field is timezone-aware and is only The `epoch_utc` calculated timestamp field is timezone-aware and is only
available if the timezone field is UTC. available if the timezone field is UTC.
@ -59,8 +59,9 @@ Schema:
} }
} }
[0] naive timestamp if date field exists and can be converted [0] naive timestamp if date field exists and can be converted.
[1] timezone aware timestamp if date field is in UTC and can be converted [1] timezone aware timestamp if date field is in UTC and can
be converted
Examples: Examples:

View File

@ -12,7 +12,7 @@ Usage (cli):
appear the output is hanging due to the OS pipe buffers. This is because appear the output is hanging due to the OS pipe buffers. This is because
`ping` output is too small to quickly fill up the buffer. Use the `-u` `ping` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. option to unbuffer the `jc` output if you would like immediate output.
See the[readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. for more information.
Usage (module): Usage (module):

View File

@ -7,7 +7,7 @@ Note: On some operating systems you will need to redirect `STDERR` to
`STDERR`. A warning message will be printed to `STDERR` if the `STDERR`. A warning message will be printed to `STDERR` if the
header row is not found. header row is not found.
e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
Usage (cli): Usage (cli):

View File

@ -38,7 +38,7 @@ Schema:
], ],
"tcp_ranges": [ "tcp_ranges": [
{ {
"start": integer, # 'any' is converted to start/end: 0/65535 "start": integer, # [0]
"end": integer "end": integer
} }
], ],