1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-08-06 22:32:54 +02:00

proc parser doc update

This commit is contained in:
Kelly Brazil
2024-01-30 10:49:19 -08:00
parent 74c7e11948
commit 9f78dc6afa
3 changed files with 22 additions and 8 deletions

View File

@ -10,10 +10,16 @@ corresponding parser to perform the parsing.
Magic syntax for converting `/proc` files is also supported by running Magic syntax for converting `/proc` files is also supported by running
`jc /proc/<path to file>`. Any `jc` options must be specified before the `jc /proc/<path to file>`. Any `jc` options must be specified before the
`/proc` path. `/proc` path. The magic syntax supports "slurping" multiple files as input.
When multiple files are selected (e.g. `jc /proc/*/stat`) all of the output
will be wrapped inside an array. Also, a `_file` field will be included in
the output which helps correlate the input and output. The `--meta-out`
option can also be used to list the `/proc` input files for correlation with
the output list.
specific Proc file parsers can also be called directly, if desired and have Specific Proc file parsers can also be called directly, if desired, and have
a naming convention of `proc-<name>` (cli) or `proc_<name>` (module). a naming convention of `proc-<name>` (cli) or `proc_<name>` (module). To see
a list of Proc file parsers, use `jc -hh` or `jc -a`.
Usage (cli): Usage (cli):
@ -141,4 +147,6 @@ Compatibility: linux
Source: [`jc/parsers/proc.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/proc.py) Source: [`jc/parsers/proc.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/proc.py)
Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) This parser can be used with the `--slurp` command-line option.
Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

View File

@ -5,10 +5,16 @@ corresponding parser to perform the parsing.
Magic syntax for converting `/proc` files is also supported by running Magic syntax for converting `/proc` files is also supported by running
`jc /proc/<path to file>`. Any `jc` options must be specified before the `jc /proc/<path to file>`. Any `jc` options must be specified before the
`/proc` path. `/proc` path. The magic syntax supports "slurping" multiple files as input.
When multiple files are selected (e.g. `jc /proc/*/stat`) all of the output
will be wrapped inside an array. Also, a `_file` field will be included in
the output which helps correlate the input and output. The `--meta-out`
option can also be used to list the `/proc` input files for correlation with
the output list.
specific Proc file parsers can also be called directly, if desired and have Specific Proc file parsers can also be called directly, if desired, and have
a naming convention of `proc-<name>` (cli) or `proc_<name>` (module). a naming convention of `proc-<name>` (cli) or `proc_<name>` (module). To see
a list of Proc file parsers, use `jc -hh` or `jc -a`.
Usage (cli): Usage (cli):

View File

@ -1,4 +1,4 @@
.TH jc 1 2024-01-29 1.24.1 "JSON Convert" .TH jc 1 2024-01-30 1.24.1 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types,
and strings and strings