Merge pull request #353 from kellyjonbrazil/dev

Dev v1.22.5

.github/workflows/pythonapp.yml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        os: [macos-latest, ubuntu-20.04, windows-latest]
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: "Set up timezone to America/Los_Angeles"
       uses: szenius/set-timezone@v1.0
       with:
@@ -25,7 +25,7 @@ jobs:
         timezoneMacos: "America/Los_Angeles"
         timezoneWindows: "Pacific Standard Time"
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

CHANGELOG

@@ -1,5 +1,164 @@
 jc changelog
 
+20230111 v1.22.5
+- Add TOML file parser
+- Add INI with duplicate key support file parser
+- Add AIX support for the `arp` command parser
+- Add AIX support for the `mount` command parser
+- Fix `lsusb` command parser when extra hub port status information is output
+- Refactor `lsusb` command parser for more code reuse
+- Fix INI file parser to include top-level values with no section header
+- Fix INI file parser to not specially handle the [DEFAULT] section
+- Fix INI file and Key/Value parsers to only remove one quotation mark from the
+  beginning and end of values.
+- Update copyright dates
+
+20221230 v1.22.4
+- Add `iwconfig` command parser
+- Add NeXTSTEP format support to the PLIST file parser
+- Fix `proc` parser magic signature detection for `/proc/pid/stat` hacks
+- Fix `x509-cert` parser for string serial numbers
+- Add category tags to parser metadata: generic, standard, file, string, binary, command
+- Add "list parsers by category" view to help
+- Fix python 3.6-related issues
+- Add python 3.6 to automated tests
+
+20221216 v1.22.3
+- Add Common Log Format and Combined Log Format file parser (standard and streaming)
+- Add PostgreSQL password file parser
+- Add openvpn-status.log file parser
+- Add `cbt` command parser (Google Big Table)
+- Enhance `ifconfig` parser with interface lane information on BSD
+- Enhance `ifconfig` parser with additional IPv6 `scope_id` info for BSD
+- Fix `ifconfig` parser to capture some IPv6 addresses missed on BSD
+- Fix `git-log` and `git-log-s` parsers for failure on empty author name
+- Update `os-prober` parser with split EFI partition fields
+- Add ISO string attribute (`.iso`) to `jc.utils.timestamp()`
+- Fix several documentation typos
+
+20221107 v1.22.2
+- add `sshd_conf` parser for `sshd` configuration files and `sshd -T` output
+- add `findmnt` command parser
+- add `git ls-remote` command parser
+- add `os-prober` command parser
+- add SemVer string parser
+- enhance the `ifconfig` parser so it can output multiple IPv4 and IPv6 addresses
+- enhance the `ifconfig` parser so it can output additional fields common on BSD
+- enhance `xml` parser with optional `_` prefix for attributes instead of
+  `@` by using the `--raw` option. This can make it easier to filter the
+  JSON output in some tools.
+- fix the `xml` parser to output a normal Dictionary instead of OrderdDict.
+  This cleans up YAML output. (No `!!omap` comments)
+- fix `csv` and `csv-s` parsers for UTF-8 encoded CSV files with leading BOM bytes
+- fix exit code to be non-zero on interrupt
+- allow parser module objects to be used as arguments to `jc.get_help()` and `jc.parser_info()`
+- catch unexpected exceptions in the CLI
+- add error message on interrupt to STDERR
+- add python 3.11 tests to github actions
+
+20221024 v1.22.1
+- add `udevadm` command parser
+- add `lspci` command parser
+- add `pci.ids` file parser
+- fix `proc-pid-stat` parser for command names with spaces and newlines
+- enhance `ip-address` parser to add `ip_split` field
+- rename `iso-datetime` parser to `datetime-iso`. A deprecation warning will
+  display until `iso-datetime` is removed in a future version.
+- refactor cli module
+- optimize performance of calculated timestamps
+- add more type annotations
+- add support for deprecating parsers
+- move jc-web demo site from heroku to render.com
+
+20220926 v1.22.0
+- Add /proc file parsers for linux. Support for the following files:
+  `/proc/buddyinfo`
+  `/proc/consoles`
+  `/proc/cpuinfo`
+  `/proc/crypto`
+  `/proc/devices`
+  `/proc/diskstats`
+  `/proc/filesystems`
+  `/proc/interrupts`
+  `/proc/iomem`
+  `/proc/ioports`
+  `/proc/loadavg`
+  `/proc/locks`
+  `/proc/meminfo`
+  `/proc/modules`
+  `/proc/mtrr`
+  `/proc/pagetypeinfo`
+  `/proc/partitions`
+  `/proc/slabinfo`
+  `/proc/softirqs`
+  `/proc/stat`
+  `/proc/swaps`
+  `/proc/uptime`
+  `/proc/version`
+  `/proc/vmallocinfo`
+  `/proc/vmstat`
+  `/proc/zoneinfo`
+  `/proc/driver/rtc`
+  `/proc/net/arp`
+  `/proc/net/dev`
+  `/proc/net/dev_mcast`
+  `/proc/net/if_inet6`
+  `/proc/net/igmp`
+  `/proc/net/igmp6`
+  `/proc/net/ipv6_route`
+  `/proc/net/netlink`
+  `/proc/net/netstat`
+  `/proc/net/packet`
+  `/proc/net/protocols`
+  `/proc/net/route`
+  `/proc/net/unix`
+  `/proc/<pid>/fdinfo/<fd>`
+  `/proc/<pid>/io`
+  `/proc/<pid>/maps`
+  `/proc/<pid>/mountinfo`
+  `/proc/<pid>/numa_maps`
+  `/proc/<pid>/smaps`
+  `/proc/<pid>/stat`
+  `/proc/<pid>/statm`
+  `/proc/<pid>/status`
+- Magic syntax support for `/proc` files
+- Enhance bash and zsh autocompletions for `/proc` files
+- Enhance `free` parser to support `-w` option integer conversions
+- Fix `ini` and `kv` parsers so they don't change keynames to lower case
+  NOTE: This can be a breaking change in your scripts
+- Fix `id` command parser to allow usernames and groupnames with spaces
+- Enhance metadata output to output metadata even when results are empty
+- Optimize tests
+- Optimize documentation build script
+
+20220829 v1.21.2
+- Fix IP Address string parser for older python versions that don't cleanly
+  accept decimal input format - IPv6 fix (e.g. python 3.6)
+
+20220828 v1.21.1
+- Fix IP Address string parser for older python versions that don't cleanly
+  accept decimal input format - IPv4 fix (e.g. python 3.6)
+- Fix `arp -a` parser for cases where incomplete hardware addresses are found
+  in the arp table on linux
+
+20220821 v1.21.0
+- Add IP Address string parser
+- Add Syslog standard and streaming string parsers (RFC 3164 and RFC 5424)
+- Add CEF standard and streaming string parser
+- Add PLIST file parser (XML and binary support)
+- Add `-n` support to the `traceroute` parser
+- Add `mdadm` command parser tested on linux
+- Add `--meta-out` or `-M` option to add metadata to the JSON output, including
+  a UTC timestamp, parser name, magic command, and magic command exit code
+- Fix `lsusb` command parser for output containing a `Device Qualifier` and
+  `Binary Object Store Descriptor` sections
+- Change `LANG=C` to `LC_ALL=C` in locale instructions
+- Add `__main__.py` to package allowing `python -m jc` usage
+- Add an enclosing top-level folder inside the windows.zip package
+
+20220723 v1.20.4
+- Fix URL string parser path list for URLs ending in a forward slash
+
 20220723 v1.20.3
 - Add URL string parser
 - Add Email Address string parser
@@ -458,7 +617,7 @@ jc changelog
 
 20200211 v1.7.3
 - Add alternative 'magic' syntax: e.g. `jc ls -al`
-- Options can now be condensed (e.g. -prq is equivalant to -p -r -q)
+- Options can now be condensed (e.g. -prq is equivalent to -p -r -q)
 
 20200208 v1.7.2
 - Include test fixtures in wheel and sdist

EXAMPLES.md

@@ -265,6 +265,37 @@ blkid -o udev -ip /dev/sda2 | jc --blkid -p          # or:  jc -p blkid -o udev
   }
 ]
 ```
+### CEF strings
+```bash
+cat cef.log | jc --cef -p
+```
+```json
+[
+  {
+    "deviceVendor": "Trend Micro",
+    "deviceProduct": "Deep Security Agent",
+    "deviceVersion": "<DSA version>",
+    "deviceEventClassId": "4000000",
+    "name": "Eicar_test_file",
+    "agentSeverity": 6,
+    "CEFVersion": 0,
+    "dvchost": "hostname",
+    "string": "hello \"world\"!",
+    "start": "Nov 08 2020 12:30:00.111 UTC",
+    "start_epoch": 1604867400,
+    "start_epoch_utc": 1604838600,
+    "Host_ID": 1,
+    "Quarantine": 205,
+    "myDate": "Nov 08 2022 12:30:00.111",
+    "myDate_epoch": 1667939400,
+    "myDate_epoch_utc": null,
+    "myFloat": 3.14,
+    "deviceEventClassIdNum": 4000000,
+    "agentSeverityString": "Medium",
+    "agentSeverityNum": 6
+  }
+]
+```
 ### chage --list
 ```bash
 chage --list joeuser | jc --chage -p          # or:  jc -p chage --list joeuser
@@ -1605,21 +1636,21 @@ cat example.ini | jc --ini -p
 ```
 ```json
 {
+  "DEFAULT": {
+    "ServerAliveInterval": "45",
+    "Compression": "yes",
+    "CompressionLevel": "9",
+    "ForwardX11": "yes"
+  },
   "bitbucket.org": {
-    "serveraliveinterval": "45",
-    "compression": "yes",
-    "compressionlevel": "9",
-    "forwardx11": "yes",
-    "user": "hg"
+    "User": "hg"
   },
   "topsecret.server.com": {
-    "serveraliveinterval": "45",
-    "compression": "yes",
-    "compressionlevel": "9",
-    "forwardx11": "no",
-    "port": "50022"
+    "Port": "50022",
+    "ForwardX11": "no"
   }
 }
+
 ```
 ### iostat
 ```bash
@@ -1665,6 +1696,71 @@ $ iostat | jc --iostat -p          # or:  jc -p iostat
   }
 ]
 ```
+### IP Address strings
+```bash
+echo 192.168.2.10/24 | jc --ip-address -p
+```
+```json
+{
+  "version": 4,
+  "max_prefix_length": 32,
+  "ip": "192.168.2.10",
+  "ip_compressed": "192.168.2.10",
+  "ip_exploded": "192.168.2.10",
+  "ip_split": [
+    "192",
+    "168",
+    "2",
+    "10"
+  ],
+  "scope_id": null,
+  "ipv4_mapped": null,
+  "six_to_four": null,
+  "teredo_client": null,
+  "teredo_server": null,
+  "dns_ptr": "10.2.168.192.in-addr.arpa",
+  "network": "192.168.2.0",
+  "broadcast": "192.168.2.255",
+  "hostmask": "0.0.0.255",
+  "netmask": "255.255.255.0",
+  "cidr_netmask": 24,
+  "hosts": 254,
+  "first_host": "192.168.2.1",
+  "last_host": "192.168.2.254",
+  "is_multicast": false,
+  "is_private": true,
+  "is_global": false,
+  "is_link_local": false,
+  "is_loopback": false,
+  "is_reserved": false,
+  "is_unspecified": false,
+  "int": {
+    "ip": 3232236042,
+    "network": 3232236032,
+    "broadcast": 3232236287,
+    "first_host": 3232236033,
+    "last_host": 3232236286
+  },
+  "hex": {
+    "ip": "c0:a8:02:0a",
+    "network": "c0:a8:02:00",
+    "broadcast": "c0:a8:02:ff",
+    "hostmask": "00:00:00:ff",
+    "netmask": "ff:ff:ff:00",
+    "first_host": "c0:a8:02:01",
+    "last_host": "c0:a8:02:fe"
+  },
+  "bin": {
+    "ip": "11000000101010000000001000001010",
+    "network": "11000000101010000000001000000000",
+    "broadcast": "11000000101010000000001011111111",
+    "hostmask": "00000000000000000000000011111111",
+    "netmask": "11111111111111111111111100000000",
+    "first_host": "11000000101010000000001000000001",
+    "last_host": "11000000101010000000001011111110"
+  }
+}
+```
 ### iptables
 ```bash
 iptables --line-numbers -v -L -t nat | jc --iptables -p          # or:  jc -p iptables --line-numbers -v -L -t nat
@@ -1729,7 +1825,7 @@ iptables --line-numbers -v -L -t nat | jc --iptables -p          # or:  jc -p ip
 ```
 ### ISO Datetime string
 ```bash
-echo "2022-07-20T14:52:45Z" | jc --iso-datetime -p
+echo "2022-07-20T14:52:45Z" | jc --datetime-iso -p
 ```
 ```json
 {
@@ -2832,6 +2928,31 @@ pip show wrapt wheel | jc --pip-show -p          # or:  jc -p pip show wrapt whe
   }
 ]
 ```
+### PLIST files
+```bash
+cat info.plist | jc --plist -p
+```
+```json
+{
+  "NSAppleScriptEnabled": true,
+  "LSMultipleInstancesProhibited": true,
+  "CFBundleInfoDictionaryVersion": "6.0",
+  "DTPlatformVersion": "GM",
+  "CFBundleIconFile": "GarageBand.icns",
+  "CFBundleName": "GarageBand",
+  "DTSDKName": "macosx10.13internal",
+  "NSSupportsAutomaticGraphicsSwitching": true,
+  "RevisionDate": "2018-12-03_14:10:56",
+  "UTImportedTypeDeclarations": [
+    {
+      "UTTypeConformsTo": [
+        "public.data",
+        "public.content"
+      ]
+    }
+  ]
+}
+```
 ### postconf -M
 ```bash
 postconf -M | jc --postconf -p          # or jc -p postconf -M
@@ -3382,6 +3503,57 @@ sysctl -a | jc --sysctl -p          # or:  jc -p sysctl -a
   "user.expr_nest_max": 32
 }
 ```
+### Syslog strings (RFC 5424)
+```bash
+cat syslog.txt | jc --syslog -p
+```
+```json
+[
+  {
+    "priority": 35,
+    "version": 1,
+    "timestamp": "2003-10-11T22:14:15.003Z",
+    "hostname": "mymachine.example.com",
+    "appname": "evntslog",
+    "proc_id": null,
+    "msg_id": "ID47",
+    "structured_data": [
+      {
+        "identity": "exampleSDID@32473",
+        "parameters": {
+          "iut": "3",
+          "eventSource": "Application",
+          "eventID": "1011"
+        }
+      },
+      {
+        "identity": "examplePriority@32473",
+        "parameters": {
+          "class": "high"
+        }
+      }
+    ],
+    "message": "unauthorized attempt",
+    "timestamp_epoch": 1065935655,
+    "timestamp_epoch_utc": 1065910455
+  }
+]
+```
+### Syslog strings (RFC 3164)
+```bash
+cat syslog.txt | jc --syslog-bsd -p
+```
+```json
+[
+  {
+    "priority": 34,
+    "date": "Oct 11 22:14:15",
+    "hostname": "mymachine",
+    "tag": "su",
+    "content": "'su root' failed for lonvick on /dev/pts/8"
+  }
+]
+```
 ### systemctl
 ```bash
 systemctl -a | jc --systemctl -p          # or:  jc -p systemctl -a

MANIFEST.in

@@ -1,2 +1,3 @@
+include jc/py.typed
 include man/jc.1
 include CHANGELOG

README.md

@@ -3,7 +3,7 @@
 
 > Check out the `jc` Python [package documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs) for developers
 
-> Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/)
+> Try the `jc` [web demo](https://jc-web.onrender.com/)
 
 > JC is [now available](https://galaxy.ansible.com/community/general) as an
 Ansible filter plugin in the `community.general` collection. See this
@@ -13,9 +13,9 @@ for an example.
 # JC
 JSON Convert
 
-`jc` JSONifies the output of many CLI tools and file-types for easier parsing in
-scripts. See the [**Parsers**](#parsers) section for supported commands and
-file-types.
+`jc` JSONifies the output of many CLI tools, file-types, and common strings
+for easier parsing in scripts. See the [**Parsers**](#parsers) section for
+supported commands, file-types, and strings.
 ```bash
 dig example.com | jc --dig
 ```
@@ -70,7 +70,7 @@ values are converted, and, in some cases, additional semantic context fields are
 added.
 
 To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True`
-function parameter in `parse()`.
+function parameter in `parse()` when using `jc` as a python library.
 
 Schemas for each parser can be found at the documentation link beside each
 [**Parser**](#parsers) below.
@@ -93,6 +93,7 @@ Use Cases:
 - [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/)
 - [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/)
 - [Nornir command output parsing](https://blog.kellybrazil.com/2020/12/09/parsing-command-output-in-nornir-with-jc/)
+- [FortiSOAR command output parsing](https://docs.fortinet.com/document/fortisoar/1.0.0/jc-parse-command-output/323/jc-parse-command-output-v1-0-0)
 
 ## Installation
 There are several ways to get `jc`. You can install via `pip`, OS package
@@ -113,13 +114,14 @@ pip3 install jc
 | Debian/Ubuntu linux                  | `apt-get install jc`                                                          |
 | Fedora linux                         | `dnf install jc`                                                              |
 | openSUSE linux                       | `zypper install jc`                                                           |
-| Archlinux Community Repository       | `paru -S jc` or `aura -S jc` or `yay -S jc`                                   |
+| Arch linux                           | `pacman -S jc`                                                                |
 | NixOS linux                          | `nix-env -iA nixpkgs.jc` or `nix-env -iA nixos.jc`                            |
 | Guix System linux                    | `guix install jc`                                                             |
 | Gentoo Linux                         | `emerge dev-python/jc`                                                        |
 | macOS                                | `brew install jc`                                                             |
 | FreeBSD                              | `portsnap fetch update && cd /usr/ports/textproc/py-jc && make install clean` |
 | Ansible filter plugin                | `ansible-galaxy collection install community.general`                         |
+| FortiSOAR connector                  | Install from FortiSOAR Connector Marketplace                                  |
 
 > For more OS Packages, see https://repology.org/project/jc/versions.
 
@@ -131,14 +133,18 @@ on Github.
 `jc` accepts piped input from `STDIN` and outputs a JSON representation of the
 previous command's output to `STDOUT`.
 ```bash
-COMMAND | jc PARSER [OPTIONS]
+COMMAND | jc [OPTIONS] PARSER
+cat FILE | jc [OPTIONS] PARSER
+echo STRING | jc [OPTIONS] PARSER
 ```
 
 Alternatively, the "magic" syntax can be used by prepending `jc` to the command
-to be converted. Options can be passed to `jc` immediately before the command is
-given. (Note: command aliases and shell builtins are not supported)
+to be converted or in front of the absolute path for Proc files. Options can be
+passed to `jc` immediately before the command or Proc file path is given.
+(Note: command aliases and shell builtins are not supported)
 ```bash
 jc [OPTIONS] COMMAND
+jc [OPTIONS] /proc/<path-to-procfile>
 ```
 
 The JSON output can be compact (default) or pretty formatted with the `-p`
@@ -155,13 +161,19 @@ option.
 | `   --asciitable` | ASCII and Unicode table parser                          | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/asciitable)     |
 | ` --asciitable-m` | multi-line ASCII and Unicode table parser               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/asciitable_m)   |
 | `        --blkid` | `blkid` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/blkid)          |
+| `          --cbt` | `cbt` (Google Bigtable) command parser                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/cbt)            |
+| `          --cef` | CEF string parser                                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/cef)            |
+| `        --cef-s` | CEF string streaming parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/cef_s)          |
 | `        --chage` | `chage --list` command parser                           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/chage)          |
 | `        --cksum` | `cksum` and `sum` command parser                        | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/cksum)          |
+| `          --clf` | Common and Combined Log Format file parser              | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/clf)            |
+| `        --clf-s` | Common and Combined Log Format file streaming parser    | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/clf_s)          |
 | `      --crontab` | `crontab` command and file parser                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab)        |
 | `    --crontab-u` | `crontab` file parser with user support                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab_u)      |
 | `          --csv` | CSV file parser                                         | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/csv)            |
 | `        --csv-s` | CSV file streaming parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/csv_s)          |
 | `         --date` | `date` command parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/date)           |
+| ` --datetime-iso` | ISO 8601 Datetime string parser                         | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/datetime_iso)   |
 | `           --df` | `df` command parser                                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/df)             |
 | `          --dig` | `dig` command parser                                    | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/dig)            |
 | `          --dir` | `dir` command parser                                    | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/dir)            |
@@ -171,11 +183,13 @@ option.
 | `--email-address` | Email Address string parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/email_address)  |
 | `          --env` | `env` command parser                                    | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/env)            |
 | `         --file` | `file` command parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/file)           |
+| `      --findmnt` | `findmnt` command parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/findmnt)        |
 | `       --finger` | `finger` command parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/finger)         |
 | `         --free` | `free` command parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/free)           |
 | `        --fstab` | `/etc/fstab` file parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/fstab)          |
 | `      --git-log` | `git log` command parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/git_log)        |
 | `    --git-log-s` | `git log` command streaming parser                      | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/git_log_s)      |
+| `--git-ls-remote` | `git ls-remote` command parser                          | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/git_ls_remote)  |
 | `          --gpg` | `gpg --with-colons` command parser                      | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/gpg)            |
 | `        --group` | `/etc/group` file parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/group)          |
 | `      --gshadow` | `/etc/gshadow` file parser                              | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/gshadow)        |
@@ -187,48 +201,64 @@ option.
 | `           --id` | `id` command parser                                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/id)             |
 | `     --ifconfig` | `ifconfig` command parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ifconfig)       |
 | `          --ini` | INI file parser                                         | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ini)            |
+| `      --ini-dup` | INI with duplicate key file parser                      | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ini_dup)        |
 | `       --iostat` | `iostat` command parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat)         |
 | `     --iostat-s` | `iostat` command streaming parser                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat_s)       |
+| `   --ip-address` | IPv4 and IPv6 Address string parser                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ip_address)     |
 | `     --iptables` | `iptables` command parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iptables)       |
-| ` --iso-datetime` | ISO 8601 Datetime string parser                         | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iso_datetime)   |
 | `      --iw-scan` | `iw dev [device] scan` command parser                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iw_scan)        |
-| ` --jar-manifest` | MANIFEST.MF file parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/jar_manifest)   |
+| `     --iwconfig` | `iwconfig` command parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iwconfig)       |
+| ` --jar-manifest` | Java MANIFEST.MF file parser                            | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/jar_manifest)   |
 | `         --jobs` | `jobs` command parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs)           |
 | `          --jwt` | JWT string parser                                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/jwt)            |
-| `           --kv` | Key/Value file parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/kv)             |
+| `           --kv` | Key/Value file and string parser                        | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/kv)             |
 | `         --last` | `last` and `lastb` command parser                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/last)           |
 | `           --ls` | `ls` command parser                                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ls)             |
 | `         --ls-s` | `ls` command streaming parser                           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ls_s)           |
 | `        --lsblk` | `lsblk` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsblk)          |
 | `        --lsmod` | `lsmod` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsmod)          |
 | `         --lsof` | `lsof` command parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsof)           |
+| `        --lspci` | `lspci -mmv` command parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lspci)          |
 | `        --lsusb` | `lsusb` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsusb)          |
 | `          --m3u` | M3U and M3U8 file parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/m3u)            |
+| `        --mdadm` | `mdadm` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mdadm)          |
 | `        --mount` | `mount` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mount)          |
 | `       --mpstat` | `mpstat` command parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mpstat)         |
 | `     --mpstat-s` | `mpstat` command streaming parser                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mpstat_s)       |
 | `      --netstat` | `netstat` command parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/netstat)        |
 | `        --nmcli` | `nmcli` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/nmcli)          |
 | `         --ntpq` | `ntpq -p` command parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq)           |
+| `      --openvpn` | openvpn-status.log file parser                          | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/openvpn)        |
+| `    --os-prober` | `os-prober` command parser                              | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/os_prober)      |
 | `       --passwd` | `/etc/passwd` file parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd)         |
-| `      --pidstat` | `pidstat -h` command parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat)        |
-| `    --pidstat-s` | `pidstat -h` command streaming parser                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s)      |
+| `      --pci-ids` | `pci.ids` file parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pci_ids)        |
+| `       --pgpass` | PostgreSQL password file parser                         | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pgpass)         |
+| `      --pidstat` | `pidstat -H` command parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat)        |
+| `    --pidstat-s` | `pidstat -H` command streaming parser                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s)      |
 | `         --ping` | `ping` and `ping6` command parser                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ping)           |
 | `       --ping-s` | `ping` and `ping6` command streaming parser             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s)         |
 | `     --pip-list` | `pip list` command parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list)       |
 | `     --pip-show` | `pip show` command parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_show)       |
+| `        --plist` | PLIST file parser                                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/plist)          |
 | `     --postconf` | `postconf -M` command parser                            | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/postconf)       |
+| `         --proc` | `/proc/` file parser                                    | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/proc)           |
 | `           --ps` | `ps` command parser                                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ps)             |
 | `        --route` | `route` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/route)          |
 | `       --rpm-qi` | `rpm -qi` command parser                                | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/rpm_qi)         |
 | `        --rsync` | `rsync` command parser                                  | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/rsync)          |
 | `      --rsync-s` | `rsync` command streaming parser                        | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/rsync_s)        |
+| `       --semver` | Semantic Version string parser                          | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/semver)         |
 | `       --sfdisk` | `sfdisk` command parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/sfdisk)         |
 | `       --shadow` | `/etc/shadow` file parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/shadow)         |
 | `           --ss` | `ss` command parser                                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ss)             |
+| `    --sshd-conf` | sshd config file and `sshd -T` command parser           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/sshd_conf)      |
 | `         --stat` | `stat` command parser                                   | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/stat)           |
 | `       --stat-s` | `stat` command streaming parser                         | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/stat_s)         |
 | `       --sysctl` | `sysctl` command parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/sysctl)         |
+| `       --syslog` | Syslog RFC 5424 string parser                           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/syslog)         |
+| `     --syslog-s` | Syslog RFC 5424 string streaming parser                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/syslog_s)       |
+| `   --syslog-bsd` | Syslog RFC 3164 string parser                           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/syslog_bsd)     |
+| ` --syslog-bsd-s` | Syslog RFC 3164 string streaming parser                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/syslog_bsd_s)   |
 | `    --systemctl` | `systemctl` command parser                              | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl)      |
 | ` --systemctl-lj` | `systemctl list-jobs` command parser                    | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_lj)   |
 | ` --systemctl-ls` | `systemctl list-sockets` command parser                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_ls)   |
@@ -236,11 +266,13 @@ option.
 | `   --systeminfo` | `systeminfo` command parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systeminfo)     |
 | `         --time` | `/usr/bin/time` command parser                          | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/time)           |
 | `  --timedatectl` | `timedatectl status` command parser                     | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/timedatectl)    |
-| `    --timestamp` | UNIX Epoch Timestamp string parser                      | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/timestamp)      |
+| `    --timestamp` | Unix Epoch Timestamp string parser                      | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/timestamp)      |
+| `         --toml` | TOML file parser                                        | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/toml)           |
 | `          --top` | `top -b` command parser                                 | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/top)            |
 | `        --top-s` | `top -b` command streaming parser                       | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/top_s)          |
 | `    --tracepath` | `tracepath` and `tracepath6` command parser             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/tracepath)      |
 | `   --traceroute` | `traceroute` and `traceroute6` command parser           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/traceroute)     |
+| `      --udevadm` | `udevadm info` command parser                           | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/udevadm)        |
 | `          --ufw` | `ufw status` command parser                             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw)            |
 | `  --ufw-appinfo` | `ufw app info [application]` command parser             | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw_appinfo)    |
 | `        --uname` | `uname -a` command parser                               | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/uname)          |
@@ -267,8 +299,9 @@ option.
 | `-a`  | `--about`       | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!)                             |
 | `-C`  | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable)                           |
 | `-d`  | `--debug`       | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging)                |
-| `-h`  | `--help`        | Help. Use `jc -h --parser_name` for parser documentation                                                            |
+| `-h`  | `--help`        | Help. Use `jc -h --parser_name` for parser documentation. Use twice to show hidden parsers (e.g. `-hh`)             |
 | `-m`  | `--monochrome`  | Monochrome output                                                                                                   |
+| `-M`  | `--meta-out`    | Add metadata to output including timestamp, parser name, magic command, magic command exit code, etc.               |                                                                        |
 | `-p`  | `--pretty`      | Pretty format the JSON output                                                                                       |
 | `-q`  | `--quiet`       | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors)                        |
 | `-r`  | `--raw`         | Raw output. Provides more literal output, typically with string values and no additional semantic processing        |
@@ -280,7 +313,9 @@ option.
 
 ### Exit Codes
 Any fatal errors within `jc` will generate an exit code of `100`, otherwise the
-exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`),
+exit code will be `0`.
+
+When using the "magic" syntax (e.g. `jc ifconfig eth0`),
 `jc` will store the exit code of the program being parsed and add it to the `jc`
 exit code. This way it is easier to determine if an error was from the parsed
 program or `jc`.
@@ -294,6 +329,44 @@ Consider the following examples using `ifconfig`:
 | `0`                  | `100`          | `100`              | Error in  `jc`                     |
 | `1`                  | `100`          | `101`              | Error in  both `ifconfig` and `jc` |
 
+When using the "magic" syntax you can also retrieve the exit code of the called
+program by using the `--meta-out` or `-M` option. This will append a `_jc_meta`
+object to the output that will include the magic command information, including
+the exit code.
+
+Here is an example with `ping`:
+```bash
+$ jc --meta-out -p ping -c2 192.168.1.252
+{
+  "destination_ip": "192.168.1.252",
+  "data_bytes": 56,
+  "pattern": null,
+  "destination": "192.168.1.252",
+  "packets_transmitted": 2,
+  "packets_received": 0,
+  "packet_loss_percent": 100.0,
+  "duplicates": 0,
+  "responses": [
+    {
+      "type": "timeout",
+      "icmp_seq": 0,
+      "duplicate": false
+    }
+  ],
+  "_jc_meta": {
+    "parser": "ping",
+    "timestamp": 1661357115.27949,
+    "magic_command": [
+      "ping",
+      "-c2",
+      "192.168.1.252"
+    ],
+    "magic_command_exit": 2
+  }
+}
+$ echo $?
+2
+```
 
 ### Setting Custom Colors via Environment Variable
 You can specify custom colors via the `JC_COLORS` environment variable. The
@@ -325,7 +398,7 @@ option.
 ### Streaming Parsers
 Most parsers load all of the data from `STDIN`, parse it, then output the entire
 JSON document serially. There are some streaming parsers (e.g. `ls-s` and
-`ping-s`) that immediately start processing and outputing the data line-by-line
+`ping-s`) that immediately start processing and outputting the data line-by-line
 as [JSON Lines](https://jsonlines.org/) (aka [NDJSON](http://ndjson.org/)) while
 it is being received from `STDIN`. This can significantly reduce the amount of
 memory required to parse large amounts of command output (e.g. `ls -lR /`) and
@@ -432,15 +505,16 @@ Local plugins may override default parsers.
 
 #### Locale
 
-For best results set the `LANG` locale environment variable to `C` or
-`en_US.UTF-8`. For example, either by setting directly on the command-line:
+For best results set the locale environment variables to `C` or
+`en_US.UTF-8` by modifying the `LC_ALL` variable:
 ```
-$ LANG=C date | jc --date
+$ LC_ALL=C date | jc --date
 ```
 
-or by exporting to the environment before running commands:
+You can also set the locale variables individually:
 ```
 $ export LANG=C
+$ export LC_NUMERIC=C
 ```
 
 On some older systems UTF-8 output will be downgraded to ASCII with `\\u`
@@ -484,12 +558,12 @@ that case you can suppress the warning message with the `-q` cli option or the
 
 macOS:
 ```bash
-cat lsof.out | jc --lsof -q
+cat lsof.out | jc -q --lsof
 ```
 
 or Windows:
 ```bash
-type lsof.out | jc --lsof -q
+type lsof.out | jc -q --lsof
 ```
 
 Tested on:
@@ -533,7 +607,7 @@ documentation.
 
 ### arp
 ```bash
-arp | jc --arp -p          # or:  jc -p arp
+arp | jc -p --arp          # or:  jc -p arp
 ```
 ```json
 [
@@ -572,7 +646,7 @@ cat homes.csv
 ...
 ```
 ```bash
-cat homes.csv | jc --csv -p
+cat homes.csv | jc -p --csv
 ```
 ```json
 [
@@ -613,7 +687,7 @@ cat homes.csv | jc --csv -p
 ```
 ### /etc/hosts file
 ```bash
-cat /etc/hosts | jc --hosts -p
+cat /etc/hosts | jc -p --hosts
 ```
 ```json
 [
@@ -640,7 +714,7 @@ cat /etc/hosts | jc --hosts -p
 ```
 ### ifconfig
 ```bash
-ifconfig | jc --ifconfig -p          # or:  jc -p ifconfig
+ifconfig | jc -p --ifconfig          # or:  jc -p ifconfig
 ```
 ```json
 [
@@ -684,43 +758,37 @@ ifconfig | jc --ifconfig -p          # or:  jc -p ifconfig
 cat example.ini
 ```
 ```
-[DEFAULT]
-ServerAliveInterval = 45
-Compression = yes
-CompressionLevel = 9
-ForwardX11 = yes
+foo = fiz
+bar = buz
 
-[bitbucket.org]
-User = hg
+[section1]
+fruit = apple
+color = blue
 
-[topsecret.server.com]
-Port = 50022
-ForwardX11 = no
+[section2]
+fruit = pear
+color = green
 ```
 ```bash
-cat example.ini | jc --ini -p
+cat example.ini | jc -p --ini
 ```
 ```json
 {
-  "bitbucket.org": {
-    "serveraliveinterval": "45",
-    "compression": "yes",
-    "compressionlevel": "9",
-    "forwardx11": "yes",
-    "user": "hg"
+  "foo": "fiz",
+  "bar": "buz",
+  "section1": {
+    "fruit": "apple",
+    "color": "blue"
   },
-  "topsecret.server.com": {
-    "serveraliveinterval": "45",
-    "compression": "yes",
-    "compressionlevel": "9",
-    "forwardx11": "no",
-    "port": "50022"
+  "section2": {
+    "fruit": "pear",
+    "color": "green"
   }
 }
 ```
 ### ls
 ```bash
-$ ls -l /usr/bin | jc --ls -p          # or:  jc -p ls -l /usr/bin
+$ ls -l /usr/bin | jc -p --ls          # or:  jc -p ls -l /usr/bin
 ```
 ```json
 [
@@ -756,7 +824,7 @@ $ ls -l /usr/bin | jc --ls -p          # or:  jc -p ls -l /usr/bin
 ```
 ### netstat
 ```bash
-netstat -apee | jc --netstat -p          # or:  jc -p netstat -apee
+netstat -apee | jc -p --netstat          # or:  jc -p netstat -apee
 ```
 ```json
 [
@@ -844,7 +912,7 @@ netstat -apee | jc --netstat -p          # or:  jc -p netstat -apee
 ```
 ### /etc/passwd file
 ```bash
-cat /etc/passwd | jc --passwd -p
+cat /etc/passwd | jc -p --passwd
 ```
 ```json
 [
@@ -870,7 +938,7 @@ cat /etc/passwd | jc --passwd -p
 ```
 ### ping
 ```bash
-ping 8.8.8.8 -c 3 | jc --ping -p          # or:  jc -p ping 8.8.8.8 -c 3
+ping 8.8.8.8 -c 3 | jc -p --ping          # or:  jc -p ping 8.8.8.8 -c 3
 ```
 ```json
 {
@@ -923,7 +991,7 @@ ping 8.8.8.8 -c 3 | jc --ping -p          # or:  jc -p ping 8.8.8.8 -c 3
 ```
 ### ps
 ```bash
-ps axu | jc --ps -p          # or:  jc -p ps axu
+ps axu | jc -p --ps          # or:  jc -p ps axu
 ```
 ```json
 [
@@ -970,7 +1038,7 @@ ps axu | jc --ps -p          # or:  jc -p ps axu
 ```
 ### traceroute
 ```bash
-traceroute -m 2 8.8.8.8 | jc --traceroute -p
+traceroute -m 2 8.8.8.8 | jc -p --traceroute
 # or:  jc -p traceroute -m 2 8.8.8.8
 ```
 ```json
@@ -1035,7 +1103,7 @@ traceroute -m 2 8.8.8.8 | jc --traceroute -p
 ```
 ### uptime
 ```bash
-uptime | jc --uptime -p          # or:  jc -p uptime
+uptime | jc -p --uptime          # or:  jc -p uptime
 ```
 ```json
 {
@@ -1080,7 +1148,7 @@ cat cd_catalog.xml
   ...
 ```
 ```bash
-cat cd_catalog.xml | jc --xml -p
+cat cd_catalog.xml | jc -p --xml
 ```
 ```json
 {
@@ -1132,7 +1200,7 @@ spec:
       mode: ISTIO_MUTUAL
 ```
 ```bash
-cat istio.yaml | jc --yaml -p
+cat istio.yaml | jc -p --yaml
 ```
 ```json
 [
@@ -1170,4 +1238,4 @@ cat istio.yaml | jc --yaml -p
 ]
 ```
 
-© 2019-2022 Kelly Brazil
+© 2019-2023 Kelly Brazil

completions/jc_bash_completion.sh

@@ -3,9 +3,9 @@ _jc()
     local cur prev words cword jc_commands jc_parsers jc_options \
           jc_about_options jc_about_mod_options jc_help_options jc_special_options
 
-    jc_commands=(acpi airport arp blkid chage cksum crontab date df dig dmidecode dpkg du env file finger free git gpg hciconfig id ifconfig iostat iptables iw jobs last lastb ls lsblk lsmod lsof lsusb md5 md5sum mount mpstat netstat nmcli ntpq pidstat ping ping6 pip pip3 postconf printenv ps route rpm rsync sfdisk sha1sum sha224sum sha256sum sha384sum sha512sum shasum ss stat sum sysctl systemctl systeminfo timedatectl top tracepath tracepath6 traceroute traceroute6 ufw uname update-alternatives upower uptime vdir vmstat w wc who xrandr zipinfo)
-    jc_parsers=(--acpi --airport --airport-s --arp --asciitable --asciitable-m --blkid --chage --cksum --crontab --crontab-u --csv --csv-s --date --df --dig --dir --dmidecode --dpkg-l --du --email-address --env --file --finger --free --fstab --git-log --git-log-s --gpg --group --gshadow --hash --hashsum --hciconfig --history --hosts --id --ifconfig --ini --iostat --iostat-s --iptables --iso-datetime --iw-scan --jar-manifest --jobs --jwt --kv --last --ls --ls-s --lsblk --lsmod --lsof --lsusb --m3u --mount --mpstat --mpstat-s --netstat --nmcli --ntpq --passwd --pidstat --pidstat-s --ping --ping-s --pip-list --pip-show --postconf --ps --route --rpm-qi --rsync --rsync-s --sfdisk --shadow --ss --stat --stat-s --sysctl --systemctl --systemctl-lj --systemctl-ls --systemctl-luf --systeminfo --time --timedatectl --timestamp --top --top-s --tracepath --traceroute --ufw --ufw-appinfo --uname --update-alt-gs --update-alt-q --upower --uptime --url --vmstat --vmstat-s --w --wc --who --x509-cert --xml --xrandr --yaml --zipinfo)
-    jc_options=(--force-color -C --debug -d --monochrome -m --pretty -p --quiet -q --raw -r --unbuffer -u --yaml-out -y)
+    jc_commands=(acpi airport arp blkid cbt chage cksum crontab date df dig dmidecode dpkg du env file findmnt finger free git gpg hciconfig id ifconfig iostat iptables iw iwconfig jobs last lastb ls lsblk lsmod lsof lspci lsusb md5 md5sum mdadm mount mpstat netstat nmcli ntpq os-prober pidstat ping ping6 pip pip3 postconf printenv ps route rpm rsync sfdisk sha1sum sha224sum sha256sum sha384sum sha512sum shasum ss sshd stat sum sysctl systemctl systeminfo timedatectl top tracepath tracepath6 traceroute traceroute6 udevadm ufw uname update-alternatives upower uptime vdir vmstat w wc who xrandr zipinfo)
+    jc_parsers=(--acpi --airport --airport-s --arp --asciitable --asciitable-m --blkid --cbt --cef --cef-s --chage --cksum --clf --clf-s --crontab --crontab-u --csv --csv-s --date --datetime-iso --df --dig --dir --dmidecode --dpkg-l --du --email-address --env --file --findmnt --finger --free --fstab --git-log --git-log-s --git-ls-remote --gpg --group --gshadow --hash --hashsum --hciconfig --history --hosts --id --ifconfig --ini --ini-dup --iostat --iostat-s --ip-address --iptables --iw-scan --iwconfig --jar-manifest --jobs --jwt --kv --last --ls --ls-s --lsblk --lsmod --lsof --lspci --lsusb --m3u --mdadm --mount --mpstat --mpstat-s --netstat --nmcli --ntpq --openvpn --os-prober --passwd --pci-ids --pgpass --pidstat --pidstat-s --ping --ping-s --pip-list --pip-show --plist --postconf --proc --proc-buddyinfo --proc-consoles --proc-cpuinfo --proc-crypto --proc-devices --proc-diskstats --proc-filesystems --proc-interrupts --proc-iomem --proc-ioports --proc-loadavg --proc-locks --proc-meminfo --proc-modules --proc-mtrr --proc-pagetypeinfo --proc-partitions --proc-slabinfo --proc-softirqs --proc-stat --proc-swaps --proc-uptime --proc-version --proc-vmallocinfo --proc-vmstat --proc-zoneinfo --proc-driver-rtc --proc-net-arp --proc-net-dev --proc-net-dev-mcast --proc-net-if-inet6 --proc-net-igmp --proc-net-igmp6 --proc-net-ipv6-route --proc-net-netlink --proc-net-netstat --proc-net-packet --proc-net-protocols --proc-net-route --proc-net-unix --proc-pid-fdinfo --proc-pid-io --proc-pid-maps --proc-pid-mountinfo --proc-pid-numa-maps --proc-pid-smaps --proc-pid-stat --proc-pid-statm --proc-pid-status --ps --route --rpm-qi --rsync --rsync-s --semver --sfdisk --shadow --ss --sshd-conf --stat --stat-s --sysctl --syslog --syslog-s --syslog-bsd --syslog-bsd-s --systemctl --systemctl-lj --systemctl-ls --systemctl-luf --systeminfo --time --timedatectl --timestamp --toml --top --top-s --tracepath --traceroute --udevadm --ufw --ufw-appinfo --uname --update-alt-gs --update-alt-q --upower --uptime --url --vmstat --vmstat-s --w --wc --who --x509-cert --xml --xrandr --yaml --zipinfo)
+    jc_options=(--force-color -C --debug -d --monochrome -m --meta-out -M --pretty -p --quiet -q --raw -r --unbuffer -u --yaml-out -y)
     jc_about_options=(--about -a)
     jc_about_mod_options=(--pretty -p --yaml-out -y --monochrome -m --force-color -C)
     jc_help_options=(--help -h)
@@ -67,6 +67,12 @@ _jc()
         fi
     done
 
+    # if "/pr[oc]" (magic for Procfile parsers) is in the current word, complete with files/directories in the path
+    if [[ "${cur}" =~ "/pr" ]]; then
+        _filedir
+        return 0
+    fi
+
     # if a parser arg is found anywhere in the line, only show options and help options
     for i in "${words[@]::${#words[@]}-1}"; do
         if [[ " ${jc_parsers[*]} " =~ " ${i} " ]]; then

completions/jc_zsh_completion.sh

@@ -9,12 +9,13 @@ _jc() {
              jc_help_options jc_help_options_describe \
              jc_special_options jc_special_options_describe
 
-    jc_commands=(acpi airport arp blkid chage cksum crontab date df dig dmidecode dpkg du env file finger free git gpg hciconfig id ifconfig iostat iptables iw jobs last lastb ls lsblk lsmod lsof lsusb md5 md5sum mount mpstat netstat nmcli ntpq pidstat ping ping6 pip pip3 postconf printenv ps route rpm rsync sfdisk sha1sum sha224sum sha256sum sha384sum sha512sum shasum ss stat sum sysctl systemctl systeminfo timedatectl top tracepath tracepath6 traceroute traceroute6 ufw uname update-alternatives upower uptime vdir vmstat w wc who xrandr zipinfo)
+    jc_commands=(acpi airport arp blkid cbt chage cksum crontab date df dig dmidecode dpkg du env file findmnt finger free git gpg hciconfig id ifconfig iostat iptables iw iwconfig jobs last lastb ls lsblk lsmod lsof lspci lsusb md5 md5sum mdadm mount mpstat netstat nmcli ntpq os-prober pidstat ping ping6 pip pip3 postconf printenv ps route rpm rsync sfdisk sha1sum sha224sum sha256sum sha384sum sha512sum shasum ss sshd stat sum sysctl systemctl systeminfo timedatectl top tracepath tracepath6 traceroute traceroute6 udevadm ufw uname update-alternatives upower uptime vdir vmstat w wc who xrandr zipinfo)
     jc_commands_describe=(
         'acpi:run "acpi" command with magic syntax.'
         'airport:run "airport" command with magic syntax.'
         'arp:run "arp" command with magic syntax.'
         'blkid:run "blkid" command with magic syntax.'
+        'cbt:run "cbt" command with magic syntax.'
         'chage:run "chage" command with magic syntax.'
         'cksum:run "cksum" command with magic syntax.'
         'crontab:run "crontab" command with magic syntax.'
@@ -26,6 +27,7 @@ _jc() {
         'du:run "du" command with magic syntax.'
         'env:run "env" command with magic syntax.'
         'file:run "file" command with magic syntax.'
+        'findmnt:run "findmnt" command with magic syntax.'
         'finger:run "finger" command with magic syntax.'
         'free:run "free" command with magic syntax.'
         'git:run "git" command with magic syntax.'
@@ -36,6 +38,7 @@ _jc() {
         'iostat:run "iostat" command with magic syntax.'
         'iptables:run "iptables" command with magic syntax.'
         'iw:run "iw" command with magic syntax.'
+        'iwconfig:run "iwconfig" command with magic syntax.'
         'jobs:run "jobs" command with magic syntax.'
         'last:run "last" command with magic syntax.'
         'lastb:run "lastb" command with magic syntax.'
@@ -43,14 +46,17 @@ _jc() {
         'lsblk:run "lsblk" command with magic syntax.'
         'lsmod:run "lsmod" command with magic syntax.'
         'lsof:run "lsof" command with magic syntax.'
+        'lspci:run "lspci" command with magic syntax.'
         'lsusb:run "lsusb" command with magic syntax.'
         'md5:run "md5" command with magic syntax.'
         'md5sum:run "md5sum" command with magic syntax.'
+        'mdadm:run "mdadm" command with magic syntax.'
         'mount:run "mount" command with magic syntax.'
         'mpstat:run "mpstat" command with magic syntax.'
         'netstat:run "netstat" command with magic syntax.'
         'nmcli:run "nmcli" command with magic syntax.'
         'ntpq:run "ntpq" command with magic syntax.'
+        'os-prober:run "os-prober" command with magic syntax.'
         'pidstat:run "pidstat" command with magic syntax.'
         'ping:run "ping" command with magic syntax.'
         'ping6:run "ping6" command with magic syntax.'
@@ -70,6 +76,7 @@ _jc() {
         'sha512sum:run "sha512sum" command with magic syntax.'
         'shasum:run "shasum" command with magic syntax.'
         'ss:run "ss" command with magic syntax.'
+        'sshd:run "sshd" command with magic syntax.'
         'stat:run "stat" command with magic syntax.'
         'sum:run "sum" command with magic syntax.'
         'sysctl:run "sysctl" command with magic syntax.'
@@ -81,6 +88,7 @@ _jc() {
         'tracepath6:run "tracepath6" command with magic syntax.'
         'traceroute:run "traceroute" command with magic syntax.'
         'traceroute6:run "traceroute6" command with magic syntax.'
+        'udevadm:run "udevadm" command with magic syntax.'
         'ufw:run "ufw" command with magic syntax.'
         'uname:run "uname" command with magic syntax.'
         'update-alternatives:run "update-alternatives" command with magic syntax.'
@@ -94,7 +102,7 @@ _jc() {
         'xrandr:run "xrandr" command with magic syntax.'
         'zipinfo:run "zipinfo" command with magic syntax.'
     )
-    jc_parsers=(--acpi --airport --airport-s --arp --asciitable --asciitable-m --blkid --chage --cksum --crontab --crontab-u --csv --csv-s --date --df --dig --dir --dmidecode --dpkg-l --du --email-address --env --file --finger --free --fstab --git-log --git-log-s --gpg --group --gshadow --hash --hashsum --hciconfig --history --hosts --id --ifconfig --ini --iostat --iostat-s --iptables --iso-datetime --iw-scan --jar-manifest --jobs --jwt --kv --last --ls --ls-s --lsblk --lsmod --lsof --lsusb --m3u --mount --mpstat --mpstat-s --netstat --nmcli --ntpq --passwd --pidstat --pidstat-s --ping --ping-s --pip-list --pip-show --postconf --ps --route --rpm-qi --rsync --rsync-s --sfdisk --shadow --ss --stat --stat-s --sysctl --systemctl --systemctl-lj --systemctl-ls --systemctl-luf --systeminfo --time --timedatectl --timestamp --top --top-s --tracepath --traceroute --ufw --ufw-appinfo --uname --update-alt-gs --update-alt-q --upower --uptime --url --vmstat --vmstat-s --w --wc --who --x509-cert --xml --xrandr --yaml --zipinfo)
+    jc_parsers=(--acpi --airport --airport-s --arp --asciitable --asciitable-m --blkid --cbt --cef --cef-s --chage --cksum --clf --clf-s --crontab --crontab-u --csv --csv-s --date --datetime-iso --df --dig --dir --dmidecode --dpkg-l --du --email-address --env --file --findmnt --finger --free --fstab --git-log --git-log-s --git-ls-remote --gpg --group --gshadow --hash --hashsum --hciconfig --history --hosts --id --ifconfig --ini --ini-dup --iostat --iostat-s --ip-address --iptables --iw-scan --iwconfig --jar-manifest --jobs --jwt --kv --last --ls --ls-s --lsblk --lsmod --lsof --lspci --lsusb --m3u --mdadm --mount --mpstat --mpstat-s --netstat --nmcli --ntpq --openvpn --os-prober --passwd --pci-ids --pgpass --pidstat --pidstat-s --ping --ping-s --pip-list --pip-show --plist --postconf --proc --proc-buddyinfo --proc-consoles --proc-cpuinfo --proc-crypto --proc-devices --proc-diskstats --proc-filesystems --proc-interrupts --proc-iomem --proc-ioports --proc-loadavg --proc-locks --proc-meminfo --proc-modules --proc-mtrr --proc-pagetypeinfo --proc-partitions --proc-slabinfo --proc-softirqs --proc-stat --proc-swaps --proc-uptime --proc-version --proc-vmallocinfo --proc-vmstat --proc-zoneinfo --proc-driver-rtc --proc-net-arp --proc-net-dev --proc-net-dev-mcast --proc-net-if-inet6 --proc-net-igmp --proc-net-igmp6 --proc-net-ipv6-route --proc-net-netlink --proc-net-netstat --proc-net-packet --proc-net-protocols --proc-net-route --proc-net-unix --proc-pid-fdinfo --proc-pid-io --proc-pid-maps --proc-pid-mountinfo --proc-pid-numa-maps --proc-pid-smaps --proc-pid-stat --proc-pid-statm --proc-pid-status --ps --route --rpm-qi --rsync --rsync-s --semver --sfdisk --shadow --ss --sshd-conf --stat --stat-s --sysctl --syslog --syslog-s --syslog-bsd --syslog-bsd-s --systemctl --systemctl-lj --systemctl-ls --systemctl-luf --systeminfo --time --timedatectl --timestamp --toml --top --top-s --tracepath --traceroute --udevadm --ufw --ufw-appinfo --uname --update-alt-gs --update-alt-q --upower --uptime --url --vmstat --vmstat-s --w --wc --who --x509-cert --xml --xrandr --yaml --zipinfo)
     jc_parsers_describe=(
         '--acpi:`acpi` command parser'
         '--airport:`airport -I` command parser'
@@ -103,13 +111,19 @@ _jc() {
         '--asciitable:ASCII and Unicode table parser'
         '--asciitable-m:multi-line ASCII and Unicode table parser'
         '--blkid:`blkid` command parser'
+        '--cbt:`cbt` (Google Bigtable) command parser'
+        '--cef:CEF string parser'
+        '--cef-s:CEF string streaming parser'
         '--chage:`chage --list` command parser'
         '--cksum:`cksum` and `sum` command parser'
+        '--clf:Common and Combined Log Format file parser'
+        '--clf-s:Common and Combined Log Format file streaming parser'
         '--crontab:`crontab` command and file parser'
         '--crontab-u:`crontab` file parser with user support'
         '--csv:CSV file parser'
         '--csv-s:CSV file streaming parser'
         '--date:`date` command parser'
+        '--datetime-iso:ISO 8601 Datetime string parser'
         '--df:`df` command parser'
         '--dig:`dig` command parser'
         '--dir:`dir` command parser'
@@ -119,11 +133,13 @@ _jc() {
         '--email-address:Email Address string parser'
         '--env:`env` command parser'
         '--file:`file` command parser'
+        '--findmnt:`findmnt` command parser'
         '--finger:`finger` command parser'
         '--free:`free` command parser'
         '--fstab:`/etc/fstab` file parser'
         '--git-log:`git log` command parser'
         '--git-log-s:`git log` command streaming parser'
+        '--git-ls-remote:`git ls-remote` command parser'
         '--gpg:`gpg --with-colons` command parser'
         '--group:`/etc/group` file parser'
         '--gshadow:`/etc/gshadow` file parser'
@@ -135,48 +151,113 @@ _jc() {
         '--id:`id` command parser'
         '--ifconfig:`ifconfig` command parser'
         '--ini:INI file parser'
+        '--ini-dup:INI with duplicate key file parser'
         '--iostat:`iostat` command parser'
         '--iostat-s:`iostat` command streaming parser'
+        '--ip-address:IPv4 and IPv6 Address string parser'
         '--iptables:`iptables` command parser'
-        '--iso-datetime:ISO 8601 Datetime string parser'
         '--iw-scan:`iw dev [device] scan` command parser'
-        '--jar-manifest:MANIFEST.MF file parser'
+        '--iwconfig:`iwconfig` command parser'
+        '--jar-manifest:Java MANIFEST.MF file parser'
         '--jobs:`jobs` command parser'
         '--jwt:JWT string parser'
-        '--kv:Key/Value file parser'
+        '--kv:Key/Value file and string parser'
         '--last:`last` and `lastb` command parser'
         '--ls:`ls` command parser'
         '--ls-s:`ls` command streaming parser'
         '--lsblk:`lsblk` command parser'
         '--lsmod:`lsmod` command parser'
         '--lsof:`lsof` command parser'
+        '--lspci:`lspci -mmv` command parser'
         '--lsusb:`lsusb` command parser'
         '--m3u:M3U and M3U8 file parser'
+        '--mdadm:`mdadm` command parser'
         '--mount:`mount` command parser'
         '--mpstat:`mpstat` command parser'
         '--mpstat-s:`mpstat` command streaming parser'
         '--netstat:`netstat` command parser'
         '--nmcli:`nmcli` command parser'
         '--ntpq:`ntpq -p` command parser'
+        '--openvpn:openvpn-status.log file parser'
+        '--os-prober:`os-prober` command parser'
         '--passwd:`/etc/passwd` file parser'
-        '--pidstat:`pidstat -h` command parser'
-        '--pidstat-s:`pidstat -h` command streaming parser'
+        '--pci-ids:`pci.ids` file parser'
+        '--pgpass:PostgreSQL password file parser'
+        '--pidstat:`pidstat -H` command parser'
+        '--pidstat-s:`pidstat -H` command streaming parser'
         '--ping:`ping` and `ping6` command parser'
         '--ping-s:`ping` and `ping6` command streaming parser'
         '--pip-list:`pip list` command parser'
         '--pip-show:`pip show` command parser'
+        '--plist:PLIST file parser'
         '--postconf:`postconf -M` command parser'
+        '--proc:`/proc/` file parser'
+        '--proc-buddyinfo:`/proc/buddyinfo` file parser'
+        '--proc-consoles:`/proc/consoles` file parser'
+        '--proc-cpuinfo:`/proc/cpuinfo` file parser'
+        '--proc-crypto:`/proc/crypto` file parser'
+        '--proc-devices:`/proc/devices` file parser'
+        '--proc-diskstats:`/proc/diskstats` file parser'
+        '--proc-filesystems:`/proc/filesystems` file parser'
+        '--proc-interrupts:`/proc/interrupts` file parser'
+        '--proc-iomem:`/proc/iomem` file parser'
+        '--proc-ioports:`/proc/ioports` file parser'
+        '--proc-loadavg:`/proc/loadavg` file parser'
+        '--proc-locks:`/proc/locks` file parser'
+        '--proc-meminfo:`/proc/meminfo` file parser'
+        '--proc-modules:`/proc/modules` file parser'
+        '--proc-mtrr:`/proc/mtrr` file parser'
+        '--proc-pagetypeinfo:`/proc/pagetypeinfo` file parser'
+        '--proc-partitions:`/proc/partitions` file parser'
+        '--proc-slabinfo:`/proc/slabinfo` file parser'
+        '--proc-softirqs:`/proc/softirqs` file parser'
+        '--proc-stat:`/proc/stat` file parser'
+        '--proc-swaps:`/proc/swaps` file parser'
+        '--proc-uptime:`/proc/uptime` file parser'
+        '--proc-version:`/proc/version` file parser'
+        '--proc-vmallocinfo:`/proc/vmallocinfo` file parser'
+        '--proc-vmstat:`/proc/vmstat` file parser'
+        '--proc-zoneinfo:`/proc/zoneinfo` file parser'
+        '--proc-driver-rtc:`/proc/driver/rtc` file parser'
+        '--proc-net-arp:`/proc/net/arp` file parser'
+        '--proc-net-dev:`/proc/net/dev` file parser'
+        '--proc-net-dev-mcast:`/proc/net/dev_mcast` file parser'
+        '--proc-net-if-inet6:`/proc/net/if_inet6` file parser'
+        '--proc-net-igmp:`/proc/net/igmp` file parser'
+        '--proc-net-igmp6:`/proc/net/igmp6` file parser'
+        '--proc-net-ipv6-route:`/proc/net/ipv6_route` file parser'
+        '--proc-net-netlink:`/proc/net/netlink` file parser'
+        '--proc-net-netstat:`/proc/net/netstat` file parser'
+        '--proc-net-packet:`/proc/net/packet` file parser'
+        '--proc-net-protocols:`/proc/net/protocols` file parser'
+        '--proc-net-route:`/proc/net/route` file parser'
+        '--proc-net-unix:`/proc/net/unix` file parser'
+        '--proc-pid-fdinfo:`/proc/<pid>/fdinfo/<fd>` file parser'
+        '--proc-pid-io:`/proc/<pid>/io` file parser'
+        '--proc-pid-maps:`/proc/<pid>/maps` file parser'
+        '--proc-pid-mountinfo:`/proc/<pid>/mountinfo` file parser'
+        '--proc-pid-numa-maps:`/proc/<pid>/numa_maps` file parser'
+        '--proc-pid-smaps:`/proc/<pid>/smaps` file parser'
+        '--proc-pid-stat:`/proc/<pid>/stat` file parser'
+        '--proc-pid-statm:`/proc/<pid>/statm` file parser'
+        '--proc-pid-status:`/proc/<pid>/status` file parser'
         '--ps:`ps` command parser'
         '--route:`route` command parser'
         '--rpm-qi:`rpm -qi` command parser'
         '--rsync:`rsync` command parser'
         '--rsync-s:`rsync` command streaming parser'
+        '--semver:Semantic Version string parser'
         '--sfdisk:`sfdisk` command parser'
         '--shadow:`/etc/shadow` file parser'
         '--ss:`ss` command parser'
+        '--sshd-conf:sshd config file and `sshd -T` command parser'
         '--stat:`stat` command parser'
         '--stat-s:`stat` command streaming parser'
         '--sysctl:`sysctl` command parser'
+        '--syslog:Syslog RFC 5424 string parser'
+        '--syslog-s:Syslog RFC 5424 string streaming parser'
+        '--syslog-bsd:Syslog RFC 3164 string parser'
+        '--syslog-bsd-s:Syslog RFC 3164 string streaming parser'
         '--systemctl:`systemctl` command parser'
         '--systemctl-lj:`systemctl list-jobs` command parser'
         '--systemctl-ls:`systemctl list-sockets` command parser'
@@ -184,11 +265,13 @@ _jc() {
         '--systeminfo:`systeminfo` command parser'
         '--time:`/usr/bin/time` command parser'
         '--timedatectl:`timedatectl status` command parser'
-        '--timestamp:UNIX Epoch Timestamp string parser'
+        '--timestamp:Unix Epoch Timestamp string parser'
+        '--toml:TOML file parser'
         '--top:`top -b` command parser'
         '--top-s:`top -b` command streaming parser'
         '--tracepath:`tracepath` and `tracepath6` command parser'
         '--traceroute:`traceroute` and `traceroute6` command parser'
+        '--udevadm:`udevadm info` command parser'
         '--ufw:`ufw status` command parser'
         '--ufw-appinfo:`ufw app info [application]` command parser'
         '--uname:`uname -a` command parser'
@@ -208,14 +291,16 @@ _jc() {
         '--yaml:YAML file parser'
         '--zipinfo:`zipinfo` command parser'
     )
-    jc_options=(--force-color -C --debug -d --monochrome -m --pretty -p --quiet -q --raw -r --unbuffer -u --yaml-out -y)
+    jc_options=(--force-color -C --debug -d --monochrome -m --meta-out -M --pretty -p --quiet -q --raw -r --unbuffer -u --yaml-out -y)
     jc_options_describe=(
-        '--force-color:force color output even when using pipes (overrides -m)'
-        '-C:force color output even when using pipes (overrides -m)'
+        '--force-color:force color output (overrides -m)'
+        '-C:force color output (overrides -m)'
         '--debug:debug (double for verbose debug)'
         '-d:debug (double for verbose debug)'
         '--monochrome:monochrome output'
         '-m:monochrome output'
+        '--meta-out:add metadata to output including timestamp, etc.'
+        '-M:add metadata to output including timestamp, etc.'
         '--pretty:pretty print output'
         '-p:pretty print output'
         '--quiet:suppress warnings (double to ignore streaming errors)'
@@ -240,8 +325,8 @@ _jc() {
         '-y:YAML output'
         '--monochrome:monochrome output'
         '-m:monochrome output'
-        '--force-color:force color output even when using pipes (overrides -m)'
-        '-C:force color output even when using pipes (overrides -m)'
+        '--force-color:force color output (overrides -m)'
+        '-C:force color output (overrides -m)'
     )
     jc_help_options=(--help -h)
     jc_help_options_describe=(
@@ -315,6 +400,13 @@ _jc() {
         fi
     done
 
+    # if "/pr[oc]" (magic for Procfile parsers) is in the current word, complete with files/directories in the path
+    if [[ "${words[-1]}" =~ "/pr" ]]; then
+        # run files completion
+        _files
+        return 0
+    fi
+
     # if a parser arg is found anywhere in the line, only show options and help options
     for i in ${words:0:-1}; do
         if (( $jc_parsers[(Ie)${i}] )); then

docgen.sh

@@ -1,6 +1,9 @@
 #!/bin/bash
 # Generate docs.md
 # requires pydoc-markdown 4.6.1
+
+# use ./docgen all to generate all docs
+
 readme_config=$(cat <<'EOF'
 {
     "processors": [
@@ -112,23 +115,25 @@ do
     parsers+=("$value")
 done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)')
 
-for parser in "${parsers[@]}"
-do (
+for parser in "${parsers[@]}"; do
     parser_name=$(jq -r '.name' <<< "$parser")
-    compatible=$(jq -r '.compatible | join(", ")' <<< "$parser")
-    version=$(jq -r '.version' <<< "$parser")
-    author=$(jq -r '.author' <<< "$parser")
-    author_email=$(jq -r '.author_email' <<< "$parser")
+        {
+            if [[ $1 == "all" ]] || ! git diff --quiet --exit-code HEAD~5 -- "parsers/${parser_name}.py"; then
+                compatible=$(jq -r '.compatible | join(", ")' <<< "$parser")
+                version=$(jq -r '.version' <<< "$parser")
+                author=$(jq -r '.author' <<< "$parser")
+                author_email=$(jq -r '.author_email' <<< "$parser")
 
-    echo "Building docs for: ${parser_name}"
-    echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md
-    pydoc-markdown -m jc.parsers."${parser_name}" "${parser_config}" >> ../docs/parsers/"${parser_name}".md
-    echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md
-    echo "Compatibility:  ${compatible}" >> ../docs/parsers/"${parser_name}".md
-    echo >> ../docs/parsers/"${parser_name}".md
-    echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md
-    echo "+++ ${parser_name} docs complete"
-) &
+                echo "Building docs for: ${parser_name}"
+                echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md
+                pydoc-markdown -m jc.parsers."${parser_name}" "${parser_config}" >> ../docs/parsers/"${parser_name}".md
+                echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md
+                echo "Compatibility:  ${compatible}" >> ../docs/parsers/"${parser_name}".md
+                echo >> ../docs/parsers/"${parser_name}".md
+                echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md
+                echo "+++ ${parser_name} docs complete"
+            fi
+        } &
 done
 wait
 echo "Document Generation Complete"

docs/lib.md

@@ -21,27 +21,49 @@ jc - JSON Convert lib module
 ### parse
 
 ```python
-def parse(parser_mod_name: str,
-          data: Union[str, bytes, Iterable[str]],
-          quiet: bool = False,
-          raw: bool = False,
-          ignore_exceptions: bool = None,
-          **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]]
+def parse(
+    parser_mod_name: Union[str, ModuleType],
+    data: Union[str, bytes, Iterable[str]],
+    quiet: bool = False,
+    raw: bool = False,
+    ignore_exceptions: bool = None,
+    **kwargs
+) -> Union[JSONDictType, List[JSONDictType], Iterator[JSONDictType]]
 ```
 
-Parse the string data using the supplied parser module.
+Parse the data (string or bytes) using the supplied parser (string or
+module object).
 
 This function provides a high-level API to simplify parser use. This
 function will call built-in parsers and custom plugin parsers.
 
-Example:
+Example (standard parsers):
 
     >>> import jc
-    >>> jc.parse('date', 'Tue Jan 18 10:23:07 PST 2022')
-    {'year': 2022, 'month': 'Jan', 'month_num': 1, 'day'...}
+    >>> date_obj = jc.parse('date', 'Tue Jan 18 10:23:07 PST 2022')
+    >>> print(f'The year is: {date_obj["year"]}')
+    The year is: 2022
+
+Example (streaming parsers):
+
+    >>> import jc
+    >>> ping_gen = jc.parse('ping_s', ping_output.splitlines())
+    >>> for item in ping_gen:
+    >>>     print(f'Response time: {item["time_ms"]} ms')
+    Response time: 102 ms
+    Response time: 109 ms
+    ...
 
 To get a list of available parser module names, use `parser_mod_list()`.
 
+Alternatively, a parser module object can be supplied:
+
+    >>> import jc
+    >>> import jc.parsers.date as jc_date
+    >>> date_obj = jc.parse(jc_date, 'Tue Jan 18 10:23:07 PST 2022')
+    >>> print(f'The year is: {date_obj["year"]}')
+    The year is: 2022
+
 You can also use the lower-level parser modules directly:
 
     >>> import jc.parsers.date
@@ -62,11 +84,14 @@ parsers without this API:
 
 Parameters:
 
-    parser_mod_name:    (string)     name of the parser module. This
-                                     function will accept module_name,
+    parser_mod_name:    (string or   name of the parser module. This
+                        Module)      function will accept module_name,
                                      cli-name, and --argument-name
                                      variants of the module name.
 
+                                     A Module object can also be passed
+                                     directly or via _get_parser()
+
     data:               (string or   data to parse (string or bytes for
                         bytes or     standard parsers, iterable of
                         iterable)    strings for streaming parsers)
@@ -88,7 +113,8 @@ Returns:
 ### parser\_mod\_list
 
 ```python
-def parser_mod_list() -> List[str]
+def parser_mod_list(show_hidden: bool = False,
+                    show_deprecated: bool = False) -> List[str]
 ```
 
 Returns a list of all available parser module names.
@@ -98,7 +124,8 @@ Returns a list of all available parser module names.
 ### plugin\_parser\_mod\_list
 
 ```python
-def plugin_parser_mod_list() -> List[str]
+def plugin_parser_mod_list(show_hidden: bool = False,
+                           show_deprecated: bool = False) -> List[str]
 ```
 
 Returns a list of plugin parser module names. This function is a
@@ -109,7 +136,8 @@ subset of `parser_mod_list()`.
 ### standard\_parser\_mod\_list
 
 ```python
-def standard_parser_mod_list() -> List[str]
+def standard_parser_mod_list(show_hidden: bool = False,
+                             show_deprecated: bool = False) -> List[str]
 ```
 
 Returns a list of standard parser module names. This function is a
@@ -121,7 +149,8 @@ parsers.
 ### streaming\_parser\_mod\_list
 
 ```python
-def streaming_parser_mod_list() -> List[str]
+def streaming_parser_mod_list(show_hidden: bool = False,
+                              show_deprecated: bool = False) -> List[str]
 ```
 
 Returns a list of streaming parser module names. This function is a
@@ -132,17 +161,19 @@ subset of `parser_mod_list()`.
 ### parser\_info
 
 ```python
-def parser_info(parser_mod_name: str, documentation: bool = False) -> Dict
+def parser_info(parser_mod_name: Union[str, ModuleType],
+                documentation: bool = False) -> ParserInfoType
 ```
 
 Returns a dictionary that includes the parser module metadata.
 
 Parameters:
 
-    parser_mod_name:    (string)     name of the parser module. This
-                                     function will accept module_name,
+    parser_mod_name:    (string or   name of the parser module. This
+                        Module)      function will accept module_name,
                                      cli-name, and --argument-name
-                                     variants of the module name.
+                                     variants of the module name as well
+                                     as a parser module object.
 
     documentation:      (boolean)    include parser docstring if True
 
@@ -151,26 +182,34 @@ Parameters:
 ### all\_parser\_info
 
 ```python
-def all_parser_info(documentation: bool = False) -> List[Dict]
+def all_parser_info(documentation: bool = False,
+                    show_hidden: bool = False,
+                    show_deprecated: bool = False) -> List[ParserInfoType]
 ```
 
 Returns a list of dictionaries that includes metadata for all parser
-modules.
+modules. By default only non-hidden, non-deprecated parsers are
+returned.
 
 Parameters:
 
     documentation:      (boolean)    include parser docstrings if True
+    show_hidden:        (boolean)    also show parsers marked as hidden
+                                     in their info metadata.
+    show_deprecated:    (boolean)    also show parsers marked as
+                                     deprecated in their info metadata.
 
 <a id="jc.lib.get_help"></a>
 
 ### get\_help
 
 ```python
-def get_help(parser_mod_name: str) -> None
+def get_help(parser_mod_name: Union[str, ModuleType]) -> None
 ```
 
 Show help screen for the selected parser.
 
 This function will accept **module_name**, **cli-name**, and
-**--argument-name** variants of the module name string.
+**--argument-name** variants of the module name string as well as a
+parser module object.
 

docs/parsers/acpi.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ acpi -V | jc --acpi
 
-    or
+or
 
     $ jc acpi -V
 

docs/parsers/airport.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ airport -I | jc --airport
 
-    or
+or
 
     $ jc airport -I
 

docs/parsers/airport_s.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ airport -s | jc --airport-s
 
-    or
+or
 
     $ jc airport -s
 

docs/parsers/arp.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ arp | jc --arp
 
-    or
+or
 
     $ jc arp
 
@@ -140,4 +140,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
-Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/blkid.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ blkid | jc --blkid
 
-    or
+or
 
     $ jc blkid
 

docs/parsers/cbt.md

@@ -0,0 +1,125 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cbt"></a>
+
+# jc.parsers.cbt
+
+jc - JSON Convert `cbt` command output parser (Google Bigtable)
+
+Parses the human-, but not machine-, friendly output of the cbt command (for
+Google's Bigtable).
+
+No effort is made to convert the data types of the values in the cells.
+
+The `timestamp_epoch` calculated timestamp field is naive. (i.e. based on
+the local time of the system the parser is run on)
+
+The `timestamp_epoch_utc` calculated timestamp field is timezone-aware and
+is only available if the timestamp has a UTC timezone.
+
+The `timestamp_iso` calculated timestamp field will only include UTC
+timezone information if the timestamp has a UTC timezone.
+
+Raw output contains all cells for each column (including timestamps), while
+the normal output contains only the latest value for each column.
+
+Usage (cli):
+
+    $ cbt | jc --cbt
+
+or
+
+    $ jc cbt
+
+Usage (module):
+
+    import jc
+    result = jc.parse('cbt', cbt_command_output)
+
+Schema:
+
+    [
+      {
+        "key":                      string,
+        "cells": {
+          <string>: {                         # column family
+            <string>:               string    # column: value
+          }
+        }
+      }
+    ]
+
+Schema (raw):
+
+    [
+      {
+        "key":                      string,
+        "cells": [
+          {
+            "column_family":        string,
+            "column":               string,
+            "value":                string,
+            "timestamp_iso":        string,
+            "timestamp_epoch":      integer,
+            "timestamp_epoch_utc":  integer
+          }
+        ]
+      }
+    ]
+
+Examples:
+
+    $ cbt -project=$PROJECT -instance=$INSTANCE lookup $TABLE foo | jc --cbt -p
+    [
+      {
+        "key": "foo",
+        "cells": {
+          "foo": {
+            "bar": "baz"
+          }
+        }
+      }
+    ]
+
+    $ cbt -project=$PROJECT -instance=$INSTANCE lookup $TABLE foo | jc --cbt -p -r
+    [
+      {
+        "key": "foo",
+        "cells": [
+          {
+            "column_family": "foo",
+            "column": "bar",
+            "value": "baz1",
+            "timestamp_iso": "1970-01-01T01:00:00",
+            "timestamp_epoch": 32400,
+            "timestamp_epoch_utc": null
+          }
+        ]
+      }
+    ]
+
+<a id="jc.parsers.cbt.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Andreas Weiden (andreas.weiden@gmail.com)

docs/parsers/cef.md

@@ -0,0 +1,146 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cef"></a>
+
+# jc.parsers.cef
+
+jc - JSON Convert CEF string parser
+
+This parser conforms to the Microfocus Arcsight CEF specification.
+
+This parser will accept a single CEF string or multiple CEF string lines.
+Any text before "CEF" will be ignored. Syslog and CEF escaped characters
+(`\\`, `\\"`, `\\]`, `\\|`, `\\=`, `\\%`, `\\#`, `\\n`, and `\\r`) are
+unescaped.
+
+Extended fields, as defined in the CEF specification, are relabeled
+and the values are converted to their respective types. Extra naive and
+UTC epoch timestamps are added where appropriate per the CEF specification.
+
+A warning message to `STDERR` will be printed if an unparsable line is found
+unless `--quiet` or `quiet=True` is used.
+
+To preserve escaping and original keynames and to prevent type conversions
+use the `--raw` CLI option or `raw=True` param in the `parse()` function.
+
+Usage (cli):
+
+    $ echo 'CEF:0|Vendor|Product|3.2.0|1|SYSTEM|1|... | jc --cef
+
+Usage (module):
+
+    import jc
+    result = jc.parse('cef', cef_string_output)
+
+Schema:
+
+See: https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors-8.3/cef-implementation-standard/Content/CEF/Chapter%201%20What%20is%20CEF.htm
+
+> Note: Special characters in key names will be converted to underscores.
+
+    [
+      {
+        "deviceVendor":                   string,
+        "deviceProduct":                  string,
+        "deviceVersion":                  string,
+        "deviceEventClassId":             string,
+        "deviceEventClassIdNum":          integer/null,
+        "name":                           string,
+        "agentSeverity":                  string/integer,
+        "agentSeverityString":            string,
+        "agentSeverityNum":               integer/null,
+        "CEFVersion":                     integer,
+        <extended fields>                 string/integer/float,  # [0]
+        <extended fields>"_epoch":        integer/null,  # [1]
+        <extended fields>"_epoch_utc":    integer/null,  # [2]
+        <custom fields>                   string,
+        "unparsable":                     string  # [3]
+      }
+    ]
+
+    [0] Will attempt to convert extended fields to the type specified in the
+        CEF specification. If conversion fails, then the field will remain
+        a string.
+    [1] Naive calculated epoch timestamp
+    [2] Timezone-aware calculated epoch timestamp. (UTC only) This value
+        will be null if a UTC timezone cannot be extracted from the original
+        timestamp string value.
+    [3] This field exists if the CEF line is not parsable. The value
+        is the original syslog line.
+
+Examples:
+
+    $ cat cef.log | jc --cef -p
+    [
+      {
+        "deviceVendor": "Trend Micro",
+        "deviceProduct": "Deep Security Agent",
+        "deviceVersion": "<DSA version>",
+        "deviceEventClassId": "4000000",
+        "name": "Eicar_test_file",
+        "agentSeverity": 6,
+        "CEFVersion": 0,
+        "dvchost": "hostname",
+        "string": "hello \"world\"!",
+        "start": "Nov 08 2020 12:30:00.111 UTC",
+        "start_epoch": 1604867400,
+        "start_epoch_utc": 1604838600,
+        "Host_ID": 1,
+        "Quarantine": 205,
+        "myDate": "Nov 08 2022 12:30:00.111",
+        "myDate_epoch": 1667939400,
+        "myDate_epoch_utc": null,
+        "myFloat": 3.14,
+        "deviceEventClassIdNum": 4000000,
+        "agentSeverityString": "Medium",
+        "agentSeverityNum": 6
+      }
+    ]
+
+    $ cat cef.log | jc --cef -p -r
+    [
+      {
+        "deviceVendor": "Trend Micro",
+        "deviceProduct": "Deep Security Agent",
+        "deviceVersion": "<DSA version>",
+        "deviceEventClassId": "4000000",
+        "name": "Eicar_test_file",
+        "agentSeverity": "6",
+        "CEFVersion": "0",
+        "cn1": "1",
+        "cn1Label": "Host ID",
+        "dvchost": "hostname",
+        "cn2": "205",
+        "cn2Label": "Quarantine",
+        "string": "hello \\\"world\\\"!",
+        "start": "Nov 08 2020 12:30:00.111 UTC",
+        "deviceCustomDate1": "Nov 08 2022 12:30:00.111",
+        "deviceCustomDate1Label": "myDate",
+        "cfp1": "3.14",
+        "cfp1Label": "myFloat"
+      }
+    ]
+
+<a id="jc.parsers.cef.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/cef_s.md

@@ -0,0 +1,124 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cef_s"></a>
+
+# jc.parsers.cef\_s
+
+jc - JSON Convert CEF string output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+This parser conforms to the Microfocus Arcsight CEF specification.
+
+This parser will accept a single CEF string or multiple CEF string lines.
+Any text before "CEF" will be ignored. Syslog and CEF escaped characters
+(`\\`, `\\"`, `\\]`, `\\|`, `\\=`, `\\%`, `\\#`, `\\n`, and `\\r`) are
+unescaped.
+
+Extended fields, as defined in the CEF specification, are relabeled
+and the values are converted to their respective types. Extra naive and
+UTC epoch timestamps are added where appropriate per the CEF specification.
+
+A warning message to `STDERR` will be printed if an unparsable line is found
+unless `--quiet` or `quiet=True` is used.
+
+To preserve escaping and original keynames and to prevent type conversions
+use the `--raw` CLI option or `raw=True` param in the `parse()` function.
+
+Usage (cli):
+
+    $ echo 'CEF:0|Vendor|Product|3.2.0|1|SYSTEM|1|... | jc --cef-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('cef_s', cef_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+See: https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors-8.3/cef-implementation-standard/Content/CEF/Chapter%201%20What%20is%20CEF.htm
+
+> Note: Special characters in key names will be converted to underscores.
+
+    {
+      "deviceVendor":                   string,
+      "deviceProduct":                  string,
+      "deviceVersion":                  string,
+      "deviceEventClassId":             string,
+      "deviceEventClassIdNum":          integer/null,
+      "name":                           string,
+      "agentSeverity":                  string/integer,
+      "agentSeverityString":            string,
+      "agentSeverityNum":               integer/null,
+      "CEFVersion":                     integer,
+      <extended fields>                 string/integer/float,  # [0]
+      <extended fields>"_epoch":        integer/null,  # [1]
+      <extended fields>"_epoch_utc":    integer/null,  # [2]
+      <custom fields>                   string,
+      "unparsable":                     string  # [3]
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":      boolean,     # false if error parsing
+        "error":        string,      # exists if "success" is false
+        "line":         string       # exists if "success" is false
+      }
+    }
+
+    [0] Will attempt to convert extended fields to the type specified in the
+        CEF specification. If conversion fails, then the field will remain
+        a string.
+    [1] Naive calculated epoch timestamp
+    [2] Timezone-aware calculated epoch timestamp. (UTC only) This value
+        will be null if a UTC timezone cannot be extracted from the original
+        timestamp string value.
+    [3] This field exists if the CEF line is not parsable. The value
+        is the original syslog line.
+
+Examples:
+
+    $ cat cef.log | jc --cef-s
+    {"deviceVendor":"Fortinet","deviceProduct":"FortiDeceptor","deviceV...}
+    {"deviceVendor":"Trend Micro","deviceProduct":"Deep Security Agent"...}
+    ...
+
+    $ cat cef.log | jc --cef-s -r
+    {"deviceVendor":"Fortinet","deviceProduct":"FortiDeceptor","deviceV...}
+    {"deviceVendor":"Trend Micro","deviceProduct":"Deep Security Agent"...}
+    ...
+
+<a id="jc.parsers.cef_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+def parse(data: Iterable[str],
+          raw: bool = False,
+          quiet: bool = False,
+          ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple]
+```
+
+Main text parsing generator function. Returns an iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/chage.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ chage -l johndoe | jc --chage
 
-    or
+or
 
     $ jc chage -l johndoe
 

docs/parsers/cksum.md

@@ -13,7 +13,7 @@ Usage (cli):
 
     $ cksum file.txt | jc --cksum
 
-    or
+or
 
     $ jc cksum file.txt
 

docs/parsers/clf.md

@@ -0,0 +1,199 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.clf"></a>
+
+# jc.parsers.clf
+
+jc - JSON Convert Common Log Format file parser
+
+This parser will handle the Common Log Format standard as specified at
+https://www.w3.org/Daemon/User/Config/Logging.html#common-logfile-format.
+
+Combined Log Format is also supported. (Referer and User Agent fields added)
+
+Extra fields may be present and will be enclosed in the `extra` field as
+a single string.
+
+If a log line cannot be parsed, an object with an `unparsable` field will
+be present with a value of the original line.
+
+The `epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ cat file.log | jc --clf
+
+Usage (module):
+
+    import jc
+    result = jc.parse('clf', common_log_file_output)
+
+Schema:
+
+Empty strings and `-` values are converted to `null`/`None`.
+
+    [
+      {
+        "host":                         string,
+        "ident":                        string,
+        "authuser":                     string,
+        "date":                         string,
+        "day":                          integer,
+        "month":                        string,
+        "year":                         integer,
+        "hour":                         integer,
+        "minute":                       integer,
+        "second":                       integer,
+        "tz":                           string,
+        "request":                      string,
+        "request_method":               string,
+        "request_url":                  string,
+        "request_version":              string,
+        "status":                       integer,
+        "bytes":                        integer,
+        "referer":                      string,
+        "user_agent":                   string,
+        "extra":                        string,
+        "epoch":                        integer,  # [0]
+        "epoch_utc":                    integer,  # [1]
+        "unparsable":                   string    # [2]
+      }
+    ]
+
+    [0] naive timestamp
+    [1] timezone-aware timestamp. Only available if timezone field is UTC
+    [2] exists if the line was not able to be parsed
+
+Examples:
+
+    $ cat file.log | jc --clf -p
+    [
+      {
+        "host": "127.0.0.1",
+        "ident": "user-identifier",
+        "authuser": "frank",
+        "date": "10/Oct/2000:13:55:36 -0700",
+        "day": 10,
+        "month": "Oct",
+        "year": 2000,
+        "hour": 13,
+        "minute": 55,
+        "second": 36,
+        "tz": "-0700",
+        "request": "GET /apache_pb.gif HTTPS/1.0",
+        "status": 200,
+        "bytes": 2326,
+        "referer": null,
+        "user_agent": null,
+        "extra": null,
+        "request_method": "GET",
+        "request_url": "/apache_pb.gif",
+        "request_version": "HTTPS/1.0",
+        "epoch": 971211336,
+        "epoch_utc": null
+      },
+      {
+        "host": "1.1.1.2",
+        "ident": null,
+        "authuser": null,
+        "date": "11/Nov/2016:03:04:55 +0100",
+        "day": 11,
+        "month": "Nov",
+        "year": 2016,
+        "hour": 3,
+        "minute": 4,
+        "second": 55,
+        "tz": "+0100",
+        "request": "GET /",
+        "status": 200,
+        "bytes": 83,
+        "referer": null,
+        "user_agent": null,
+        "extra": "- 9221 1.1.1.1",
+        "request_method": "GET",
+        "request_url": "/",
+        "request_version": null,
+        "epoch": 1478862295,
+        "epoch_utc": null
+      },
+      ...
+    ]
+
+    $ cat file.log | jc --clf -p -r
+    [
+      {
+        "host": "127.0.0.1",
+        "ident": "user-identifier",
+        "authuser": "frank",
+        "date": "10/Oct/2000:13:55:36 -0700",
+        "day": "10",
+        "month": "Oct",
+        "year": "2000",
+        "hour": "13",
+        "minute": "55",
+        "second": "36",
+        "tz": "-0700",
+        "request": "GET /apache_pb.gif HTTPS/1.0",
+        "status": "200",
+        "bytes": "2326",
+        "referer": null,
+        "user_agent": null,
+        "extra": "",
+        "request_method": "GET",
+        "request_url": "/apache_pb.gif",
+        "request_version": "HTTPS/1.0"
+      },
+      {
+        "host": "1.1.1.2",
+        "ident": "-",
+        "authuser": "-",
+        "date": "11/Nov/2016:03:04:55 +0100",
+        "day": "11",
+        "month": "Nov",
+        "year": "2016",
+        "hour": "03",
+        "minute": "04",
+        "second": "55",
+        "tz": "+0100",
+        "request": "GET /",
+        "status": "200",
+        "bytes": "83",
+        "referer": "-",
+        "user_agent": "-",
+        "extra": "- 9221 1.1.1.1",
+        "request_method": "GET",
+        "request_url": "/",
+        "request_version": null
+      },
+      ...
+    ]
+
+<a id="jc.parsers.clf.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/clf_s.md

@@ -0,0 +1,117 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.clf_s"></a>
+
+# jc.parsers.clf\_s
+
+jc - JSON Convert Common Log Format file streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+This parser will handle the Common Log Format standard as specified at
+https://www.w3.org/Daemon/User/Config/Logging.html#common-logfile-format.
+
+Combined Log Format is also supported. (Referer and User Agent fields added)
+
+Extra fields may be present and will be enclosed in the `extra` field as
+a single string.
+
+If a log line cannot be parsed, an object with an `unparsable` field will
+be present with a value of the original line.
+
+The `epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ cat file.log | jc --clf-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('clf_s', common_log_file_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    Empty strings and `-` values are converted to `null`/`None`.
+
+    {
+      "host":                         string,
+      "ident":                        string,
+      "authuser":                     string,
+      "date":                         string,
+      "day":                          integer,
+      "month":                        string,
+      "year":                         integer,
+      "hour":                         integer,
+      "minute":                       integer,
+      "second":                       integer,
+      "tz":                           string,
+      "request":                      string,
+      "request_method":               string,
+      "request_url":                  string,
+      "request_version":              string,
+      "status":                       integer,
+      "bytes":                        integer,
+      "referer":                      string,
+      "user_agent":                   string,
+      "extra":                        string,
+      "epoch":                        integer,  # [0]
+      "epoch_utc":                    integer,  # [1]
+      "unparsable":                   string    # [2]
+    }
+
+    [0] naive timestamp
+    [1] timezone-aware timestamp. Only available if timezone field is UTC
+    [2] exists if the line was not able to be parsed
+
+Examples:
+
+    $ cat file.log | jc --clf-s
+    {"host":"127.0.0.1","ident":"user-identifier","authuser":"frank","...}
+    {"host":"1.1.1.2","ident":null,"authuser":null,"date":"11/Nov/2016...}
+    ...
+
+    $ cat file.log | jc --clf-s -r
+    {"host":"127.0.0.1","ident":"user-identifier","authuser":"frank","...}
+    {"host":"1.1.1.2","ident":"-","authuser":"-","date":"11/Nov/2016:0...}
+    ...
+
+<a id="jc.parsers.clf_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+def parse(data: Iterable[str],
+          raw: bool = False,
+          quiet: bool = False,
+          ignore_exceptions: bool = False) -> StreamingOutputType
+```
+
+Main text parsing generator function. Returns an iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab.md

@@ -12,7 +12,7 @@ Usage (cli):
 
     $ crontab -l | jc --crontab
 
-    or
+or
 
     $ jc crontab -l
 

docs/parsers/csv.md

@@ -82,7 +82,9 @@ Examples:
 ### parse
 
 ```python
-def parse(data, raw=False, quiet=False)
+def parse(data: Union[str, bytes],
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
 ```
 
 Main text parsing function
@@ -100,4 +102,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv_s.md

@@ -86,4 +86,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/date.md

@@ -15,7 +15,7 @@ Usage (cli):
 
     $ date | jc --date
 
-    or
+or
 
     $ jc date
 

docs/parsers/datetime_iso.md

@@ -0,0 +1,91 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.datetime_iso"></a>
+
+# jc.parsers.datetime\_iso
+
+jc - JSON Convert ISO 8601 Datetime string parser
+
+This parser supports standard ISO 8601 strings that include both date and
+time. If no timezone or offset information is available in the string, then
+UTC timezone is used.
+
+Usage (cli):
+
+    $ echo "2022-07-20T14:52:45Z" | jc --iso-datetime
+
+Usage (module):
+
+    import jc
+    result = jc.parse('iso_datetime', iso_8601_string)
+
+Schema:
+
+    {
+      "year":               integer,
+      "month":              string,
+      "month_num":          integer,
+      "day":                integer,
+      "weekday":            string,
+      "weekday_num":        integer,
+      "hour":               integer,
+      "hour_24":            integer,
+      "minute":             integer,
+      "second":             integer,
+      "microsecond":        integer,
+      "period":             string,
+      "utc_offset":         string,
+      "day_of_year":        integer,
+      "week_of_year":       integer,
+      "iso":                string,
+      "timestamp":          integer  # [0]
+    }
+
+    [0] timezone aware UNIX timestamp expressed in UTC
+
+Examples:
+
+    $ echo "2022-07-20T14:52:45Z" | jc --iso-datetime -p
+    {
+      "year": 2022,
+      "month": "Jul",
+      "month_num": 7,
+      "day": 20,
+      "weekday": "Wed",
+      "weekday_num": 3,
+      "hour": 2,
+      "hour_24": 14,
+      "minute": 52,
+      "second": 45,
+      "microsecond": 0,
+      "period": "PM",
+      "utc_offset": "+0000",
+      "day_of_year": 201,
+      "week_of_year": 29,
+      "iso": "2022-07-20T14:52:45+00:00",
+      "timestamp": 1658328765
+    }
+
+<a id="jc.parsers.datetime_iso.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/df.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ df | jc --df
 
-    or
+or
 
     $ jc df
 

docs/parsers/dig.md

@@ -20,7 +20,7 @@ Usage (cli):
 
     $ dig example.com | jc --dig
 
-    or
+or
 
     $ jc dig example.com
 
@@ -106,7 +106,7 @@ Schema:
     ]
 
     [0] naive timestamp if "when" field is parsable, else null
-    [1] timezone aware timestamp availabe for UTC, else null
+    [1] timezone aware timestamp available for UTC, else null
 
 Examples:
 

docs/parsers/dmidecode.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ dmidecode | jc --dmidecode
 
-    or
+or
 
     $ jc dmidecode
 

docs/parsers/dpkg_l.md

@@ -14,7 +14,7 @@ Usage (cli):
 
     $ dpkg -l | jc --dpkg-l
 
-    or
+or
 
     $ jc dpkg -l
 

docs/parsers/du.md

@@ -5,11 +5,15 @@
 
 jc - JSON Convert `du` command output parser
 
+The `du -h` option is not supported with the default output. If you
+would like to use `du -h` or other options that change the output, be sure
+to use `jc --raw` (cli) or `raw=True` (module).
+
 Usage (cli):
 
     $ du | jc --du
 
-    or
+or
 
     $ jc du
 

docs/parsers/env.md

@@ -14,7 +14,7 @@ Usage (cli):
 
     $ env | jc --env
 
-    or
+or
 
     $ jc env
 

docs/parsers/file.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ file * | jc --file
 
-    or
+or
 
     $ jc file *
 

docs/parsers/findmnt.md

@@ -0,0 +1,117 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.findmnt"></a>
+
+# jc.parsers.findmnt
+
+jc - JSON Convert `findmnt` command output parser
+
+Supports `-a`, `-l`, or no `findmnt` options.
+
+> Note: Newer versions of `findmnt` have a JSON output option.
+
+Usage (cli):
+
+    $ findmnt | jc --findmnt
+
+or
+
+    $ jc findmnt
+
+Usage (module):
+
+    import jc
+    result = jc.parse('findmnt', findmnt_command_output)
+
+Schema:
+
+    [
+      {
+        "target":                   string,
+        "source":                   string,
+        "fstype":                   string,
+        "options": [
+                                    string
+        ],
+        "kv_options": {
+          "<key_name>":             string
+        }
+    ]
+
+Examples:
+
+    $ findmnt | jc --findmnt -p
+    [
+      {
+        "target": "/",
+        "source": "/dev/mapper/centos-root",
+        "fstype": "xfs",
+        "options": [
+          "rw",
+          "relatime",
+          "seclabel",
+          "attr2",
+          "inode64",
+          "noquota"
+        ]
+      },
+      {
+        "target": "/sys/fs/cgroup",
+        "source": "tmpfs",
+        "fstype": "tmpfs",
+        "options": [
+          "ro",
+          "nosuid",
+          "nodev",
+          "noexec",
+          "seclabel"
+        ],
+        "kv_options": {
+          "mode": "755"
+        }
+      },
+      ...
+    ]
+
+    $ findmnt | jc --findmnt -p -r
+    [
+      {
+        "target": "/",
+        "source": "/dev/mapper/centos-root",
+        "fstype": "xfs",
+        "options": "rw,relatime,seclabel,attr2,inode64,noquota"
+      },
+      {
+        "target": "/sys/fs/cgroup",
+        "source": "tmpfs",
+        "fstype": "tmpfs",
+        "options": "ro,nosuid,nodev,noexec,seclabel,mode=755"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.findmnt.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/finger.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ finger | jc --finger
 
-    or
+or
 
     $ jc finger
 

docs/parsers/free.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ free | jc --free
 
-    or
+or
 
     $ jc free
 
@@ -95,4 +95,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux
 
-Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/git_log.md

@@ -26,7 +26,7 @@ Usage (cli):
 
     $ git log | jc --git-log
 
-    or
+or
 
     $ jc git log
 
@@ -40,13 +40,13 @@ Schema:
     [
       {
         "commit":               string,
-        "author":               string,
-        "author_email":         string,
+        "author":               string/null,
+        "author_email":         string/null,
         "date":                 string,
         "epoch":                integer,  # [0]
         "epoch_utc":            integer,  # [1]
-        "commit_by":            string,
-        "commit_by_email":      string,
+        "commit_by":            string/null,
+        "commit_by_email":      string/null,
         "commit_by_date":       string,
         "message":              string,
         "stats" : {
@@ -61,7 +61,7 @@ Schema:
     ]
 
     [0] naive timestamp if "date" field is parsable, else null
-    [1] timezone aware timestamp availabe for UTC, else null
+    [1] timezone aware timestamp available for UTC, else null
 
 Examples:
 
@@ -172,4 +172,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/git_log_s.md

@@ -41,13 +41,13 @@ Schema:
 
     {
       "commit":               string,
-      "author":               string,
-      "author_email":         string,
+      "author":               string/null,
+      "author_email":         string/null,
       "date":                 string,
       "epoch":                integer,  # [0]
       "epoch_utc":            integer,  # [1]
-      "commit_by":            string,
-      "commit_by_email":      string,
+      "commit_by":            string/null,
+      "commit_by_email":      string/null,
       "commit_by_date":       string,
       "message":              string,
       "stats" : {
@@ -68,7 +68,7 @@ Schema:
     }
 
     [0] naive timestamp if "date" field is parsable, else null
-    [1] timezone aware timestamp availabe for UTC, else null
+    [1] timezone aware timestamp available for UTC, else null
 
 Examples:
 
@@ -108,4 +108,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/git_ls_remote.md

@@ -0,0 +1,92 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.git_ls_remote"></a>
+
+# jc.parsers.git\_ls\_remote
+
+jc - JSON Convert `git ls-remote` command output parser
+
+This parser outputs two schemas:
+
+- Default: A single object with key/value pairs
+- Raw: An array of objects (`--raw` (cli) or `raw=True (module))
+
+See the Schema section for more details
+
+Usage (cli):
+
+    $ git ls-remote | jc --git-ls-remote
+
+or
+
+    $ jc git ls-remote
+
+Usage (module):
+
+    import jc
+    result = jc.parse('git_ls_remote', git_ls_remote_command_output)
+
+Schema:
+
+    Default:
+    {
+      <reference>:            string
+    }
+
+    Raw:
+    [
+      {
+        "reference":          string,
+        "commit":             string
+      }
+    ]
+
+Examples:
+
+    $ git ls-remote | jc --git-ls-remote -p
+    {
+      "HEAD": "214cd6b9e09603b3c4fa02203b24fb2bc3d4e338",
+      "refs/heads/dev": "b884f6aacca39e05994596d8fdfa7e7c4f1e0389",
+      "refs/heads/master": "214cd6b9e09603b3c4fa02203b24fb2bc3d4e338",
+      "refs/pull/1/head": "e416c77bed1267254da972b0f95b7ff1d43fccef",
+      ...
+    }
+
+    $ git ls-remote | jc --git-ls-remote -p -r
+    [
+      {
+        "reference": "HEAD",
+        "commit": "214cd6b9e09603b3c4fa02203b24fb2bc3d4e338"
+      },
+      {
+        "reference": "refs/heads/dev",
+        "commit": "b884f6aacca39e05994596d8fdfa7e7c4f1e0389"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.git_ls_remote.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> Union[JSONDictType, List[JSONDictType]]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary (default) or List of Dictionaries (raw)
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/gpg.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ gpg --with-colons --show-keys file.gpg | jc --gpg
 
-    or
+or
 
     $ jc gpg --with-colons --show-keys file.gpg
 

docs/parsers/hashsum.md

@@ -19,7 +19,7 @@ Usage (cli):
 
     $ md5sum file.txt | jc --hashsum
 
-    or
+or
 
     $ jc md5sum file.txt
 

docs/parsers/hciconfig.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ hciconfig | jc --hciconfig
 
-    or
+or
 
     $ jc hciconfig
 

docs/parsers/id.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ id | jc --id
 
-    or
+or
 
     $ jc id
 
@@ -128,4 +128,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ifconfig.md

@@ -5,13 +5,16 @@
 
 jc - JSON Convert `ifconfig` command output parser
 
-> Note: No `ifconfig` options are supported.
+No `ifconfig` options are supported.
+
+Consider using the `ip` command instead of `ifconfig` as it supports native
+JSON output.
 
 Usage (cli):
 
     $ ifconfig | jc --ifconfig
 
-    or
+or
 
     $ jc ifconfig
 
@@ -24,40 +27,92 @@ Schema:
 
     [
       {
-        "name":             string,
-        "flags":            integer,
+        "name":                     string,
+        "type":                     string,
+        "metric":                   integer
+        "flags":                    integer,
         "state": [
-                            string
+                                    string
         ],
-        "mtu":              integer,
-        "ipv4_addr":        string,
-        "ipv4_mask":        string,
-        "ipv4_bcast":       string,
-        "ipv6_addr":        string,
-        "ipv6_mask":        integer,
-        "ipv6_scope":       string,
-        "mac_addr":         string,
-        "type":             string,
-        "rx_packets":       integer,
-        "rx_bytes":         integer,
-        "rx_errors":        integer,
-        "rx_dropped":       integer,
-        "rx_overruns":      integer,
-        "rx_frame":         integer,
-        "tx_packets":       integer,
-        "tx_bytes":         integer,
-        "tx_errors":        integer,
-        "tx_dropped":       integer,
-        "tx_overruns":      integer,
-        "tx_carrier":       integer,
-        "tx_collisions":    integer,
-        "metric":           integer
+        "mtu":                      integer,
+        "mac_addr":                 string,
+        "ipv4_addr":                string,    # [0]
+        "ipv4_mask":                string,    # [0]
+        "ipv4_bcast":               string,    # [0]
+        "ipv6_addr":                string,    # [0]
+        "ipv6_mask":                integer,   # [0]
+        "ipv6_scope":               string,    # [0]
+        "ipv6_scope_id":            string,    # [0]
+        "ipv6_type":                string,    # [0]
+        "rx_packets":               integer,
+        "rx_bytes":                 integer,
+        "rx_errors":                integer,
+        "rx_dropped":               integer,
+        "rx_overruns":              integer,
+        "rx_frame":                 integer,
+        "tx_packets":               integer,
+        "tx_bytes":                 integer,
+        "tx_errors":                integer,
+        "tx_dropped":               integer,
+        "tx_overruns":              integer,
+        "tx_carrier":               integer,
+        "tx_collisions":            integer,
+        "options":                  string,
+        "options_flags": [
+                                    string
+        ],
+        "status":                   string,
+        "hw_address":               string,
+        "media":                    string,
+        "media_flags": [
+                                    string
+        ],
+        "nd6_options":              integer,
+        "nd6_flags": [
+                                    string
+        ],
+        "plugged":                  string,
+        "vendor":                   string,
+        "vendor_pn":                string,
+        "vendor_sn":                string,
+        "vendor_date":              string,
+        "module_temperature":       string,
+        "module_voltage":           string
+        "ipv4": [
+          {
+            "address":              string,
+            "mask":                 string,
+            "broadcast":            string
+          }
+        ],
+        "ipv6: [
+          {
+            "address":              string,
+            "scope_id":             string,
+            "mask":                 integer,
+            "scope":                string,
+            "type":                 string
+          }
+        ],
+        "lanes": [
+          {
+            "lane":                 integer,
+            "rx_power_mw":          float,
+            "rx_power_dbm":         float,
+            "tx_bias_ma":           float
+          }
+        ]
       }
     ]
 
+    [0] these fields only pick up the last IP address in the interface
+        output and are here for backwards compatibility. For information on
+        all IP addresses, use the `ipv4` and `ipv6` objects which contain an
+        array of IP address objects.
+
 Examples:
 
-    $ ifconfig | jc --ifconfig -p
+    $ ifconfig ens33 | jc --ifconfig -p
     [
       {
         "name": "ens33",
@@ -69,120 +124,94 @@ Examples:
           "MULTICAST"
         ],
         "mtu": 1500,
+        "type": "Ethernet",
+        "mac_addr": "00:0c:29:3b:58:0e",
         "ipv4_addr": "192.168.71.137",
         "ipv4_mask": "255.255.255.0",
         "ipv4_bcast": "192.168.71.255",
         "ipv6_addr": "fe80::c1cb:715d:bc3e:b8a0",
         "ipv6_mask": 64,
         "ipv6_scope": "0x20",
-        "mac_addr": "00:0c:29:3b:58:0e",
-        "type": "Ethernet",
+        "ipv6_type": "link",
+        "metric": null,
         "rx_packets": 8061,
-        "rx_bytes": 1514413,
         "rx_errors": 0,
         "rx_dropped": 0,
         "rx_overruns": 0,
         "rx_frame": 0,
         "tx_packets": 4502,
+        "tx_errors": 0,
+        "tx_dropped": 0,
+        "tx_overruns": 0,
+        "tx_carrier": 0,
+        "tx_collisions": 0,
+        "rx_bytes": 1514413,
         "tx_bytes": 866622,
-        "tx_errors": 0,
-        "tx_dropped": 0,
-        "tx_overruns": 0,
-        "tx_carrier": 0,
-        "tx_collisions": 0,
-        "metric": null
-      },
-      {
-        "name": "lo",
-        "flags": 73,
-        "state": [
-          "UP",
-          "LOOPBACK",
-          "RUNNING"
+        "ipv4": [
+          {
+            "address": "192.168.71.137",
+            "mask": "255.255.255.0",
+            "broadcast": "192.168.71.255"
+          }
         ],
-        "mtu": 65536,
-        "ipv4_addr": "127.0.0.1",
-        "ipv4_mask": "255.0.0.0",
-        "ipv4_bcast": null,
-        "ipv6_addr": "::1",
-        "ipv6_mask": 128,
-        "ipv6_scope": "0x10",
-        "mac_addr": null,
-        "type": "Local Loopback",
-        "rx_packets": 73,
-        "rx_bytes": 6009,
-        "rx_errors": 0,
-        "rx_dropped": 0,
-        "rx_overruns": 0,
-        "rx_frame": 0,
-        "tx_packets": 73,
-        "tx_bytes": 6009,
-        "tx_errors": 0,
-        "tx_dropped": 0,
-        "tx_overruns": 0,
-        "tx_carrier": 0,
-        "tx_collisions": 0,
-        "metric": null
+        "ipv6": [
+          {
+            "address": "fe80::c1cb:715d:bc3e:b8a0",
+            "scope_id": null,
+            "mask": 64,
+            "scope": "0x20",
+            "type": "link"
+          }
+        ]
       }
     ]
 
-    $ ifconfig | jc --ifconfig -p -r
+    $ ifconfig ens33 | jc --ifconfig -p -r
     [
       {
         "name": "ens33",
         "flags": "4163",
         "state": "UP,BROADCAST,RUNNING,MULTICAST",
         "mtu": "1500",
+        "type": "Ethernet",
+        "mac_addr": "00:0c:29:3b:58:0e",
         "ipv4_addr": "192.168.71.137",
         "ipv4_mask": "255.255.255.0",
         "ipv4_bcast": "192.168.71.255",
         "ipv6_addr": "fe80::c1cb:715d:bc3e:b8a0",
         "ipv6_mask": "64",
         "ipv6_scope": "0x20",
-        "mac_addr": "00:0c:29:3b:58:0e",
-        "type": "Ethernet",
+        "ipv6_type": "link",
+        "metric": null,
         "rx_packets": "8061",
-        "rx_bytes": "1514413",
         "rx_errors": "0",
         "rx_dropped": "0",
         "rx_overruns": "0",
         "rx_frame": "0",
         "tx_packets": "4502",
+        "tx_errors": "0",
+        "tx_dropped": "0",
+        "tx_overruns": "0",
+        "tx_carrier": "0",
+        "tx_collisions": "0",
+        "rx_bytes": "1514413",
         "tx_bytes": "866622",
-        "tx_errors": "0",
-        "tx_dropped": "0",
-        "tx_overruns": "0",
-        "tx_carrier": "0",
-        "tx_collisions": "0",
-        "metric": null
-      },
-      {
-        "name": "lo",
-        "flags": "73",
-        "state": "UP,LOOPBACK,RUNNING",
-        "mtu": "65536",
-        "ipv4_addr": "127.0.0.1",
-        "ipv4_mask": "255.0.0.0",
-        "ipv4_bcast": null,
-        "ipv6_addr": "::1",
-        "ipv6_mask": "128",
-        "ipv6_scope": "0x10",
-        "mac_addr": null,
-        "type": "Local Loopback",
-        "rx_packets": "73",
-        "rx_bytes": "6009",
-        "rx_errors": "0",
-        "rx_dropped": "0",
-        "rx_overruns": "0",
-        "rx_frame": "0",
-        "tx_packets": "73",
-        "tx_bytes": "6009",
-        "tx_errors": "0",
-        "tx_dropped": "0",
-        "tx_overruns": "0",
-        "tx_carrier": "0",
-        "tx_collisions": "0",
-        "metric": null
+        "ipv4": [
+          {
+            "address": "192.168.71.137",
+            "mask": "255.255.255.0",
+            "broadcast": "192.168.71.255"
+          }
+        ],
+        "ipv6": [
+          {
+            "address": "fe80::c1cb:715d:bc3e:b8a0",
+            "scope_id": null,
+            "mask": "64",
+            "scope": "0x20",
+            "type": "link"
+          }
+        ]
       }
     ]
 
@@ -191,7 +220,9 @@ Examples:
 ### parse
 
 ```python
-def parse(data, raw=False, quiet=False)
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
 ```
 
 Main text parsing function
@@ -209,4 +240,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
-Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ini.md

@@ -3,13 +3,15 @@
 
 # jc.parsers.ini
 
-jc - JSON Convert `INI` file parser
+jc - JSON Convert INI file parser
 
-Parses standard `INI` files and files containing simple key/value pairs.
+Parses standard INI files.
 
 - Delimiter can be `=` or `:`. Missing values are supported.
 - Comment prefix can be `#` or `;`. Comments must be on their own line.
 - If duplicate keys are found, only the last value will be used.
+- If any section names have the same name as a top-level key, the top-level
+  key will be overwritten by the section data.
 
 > Note: Values starting and ending with double or single quotation marks
 > will have the marks removed. If you would like to keep the quotation
@@ -27,45 +29,47 @@ Usage (module):
 
 Schema:
 
-ini or key/value document converted to a dictionary - see the configparser
+INI document converted to a dictionary - see the python configparser
 standard library documentation for more details.
 
     {
-      "key1":       string,
-      "key2":       string
+      "<key1>":               string,
+      "<key2>":               string,
+      "<section1>": {
+        "<key1>":             string,
+        "<key2>":             string
+      },
+      "<section2>": {
+        "<key1>":             string,
+        "<key2>":             string
+      }
     }
 
 Examples:
 
     $ cat example.ini
-    [DEFAULT]
-    ServerAliveInterval = 45
-    Compression = yes
-    CompressionLevel = 9
-    ForwardX11 = yes
+    foo = fiz
+    bar = buz
 
-    [bitbucket.org]
-    User = hg
+    [section1]
+    fruit = apple
+    color = blue
 
-    [topsecret.server.com]
-    Port = 50022
-    ForwardX11 = no
+    [section2]
+    fruit = pear
+    color = green
 
     $ cat example.ini | jc --ini -p
     {
-      "bitbucket.org": {
-        "serveraliveinterval": "45",
-        "compression": "yes",
-        "compressionlevel": "9",
-        "forwardx11": "yes",
-        "user": "hg"
+      "foo": "fiz",
+      "bar": "buz",
+      "section1": {
+        "fruit": "apple",
+        "color": "blue"
       },
-      "topsecret.server.com": {
-        "serveraliveinterval": "45",
-        "compression": "yes",
-        "compressionlevel": "9",
-        "forwardx11": "no",
-        "port": "50022"
+      "section2": {
+        "fruit": "pear",
+        "color": "green"
       }
     }
 
@@ -87,9 +91,9 @@ Parameters:
 
 Returns:
 
-    Dictionary representing the ini file
+    Dictionary representing the INI file.
 
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 2.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ini_dup.md

@@ -0,0 +1,121 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ini_dup"></a>
+
+# jc.parsers.ini\_dup
+
+jc - JSON Convert INI with duplicate key file parser
+
+Parses standard INI files and preserves duplicate values. All values are
+contained in lists/arrays.
+
+- Delimiter can be `=` or `:`. Missing values are supported.
+- Comment prefix can be `#` or `;`. Comments must be on their own line.
+- If any section names have the same name as a top-level key, the top-level
+  key will be overwritten by the section data.
+- If multi-line values are used, each line will be a separate item in the
+  value list. Blank lines in multi-line values are not supported.
+
+> Note: Values starting and ending with double or single quotation marks
+> will have the marks removed. If you would like to keep the quotation
+> marks, use the `-r` command-line argument or the `raw=True` argument in
+> `parse()`.
+
+Usage (cli):
+
+    $ cat foo.ini | jc --ini
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ini', ini_file_output)
+
+Schema:
+
+INI document converted to a dictionary - see the python configparser
+standard library documentation for more details.
+
+    {
+      "<key1>": [
+                            string
+      ],
+      "<key2>": [
+                            string
+      ],
+      "<section1>": {
+        "<key1>": [
+                            string
+        ],
+        "<key2>": [
+                            string
+        ]
+      }
+    }
+
+Examples:
+
+    $ cat example.ini
+    foo = fiz
+    bar = buz
+
+    [section1]
+    fruit = apple
+    color = blue
+    color = red
+
+    [section2]
+    fruit = pear
+    fruit = peach
+    color = green
+
+    $ cat example.ini | jc --ini -p
+    {
+      "foo": [
+        "fiz"
+      ],
+      "bar": [
+        "buz"
+      ],
+      "section1": {
+        "fruit": [
+          "apple"
+        ],
+        "color": [
+          "blue",
+          "red"
+        ]
+      },
+      "section2": {
+        "fruit": [
+          "pear",
+          "peach"
+        ],
+        "color": [
+          "green"
+        ]
+      }
+    }
+
+<a id="jc.parsers.ini_dup.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary representing the INI file.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ iostat | jc --iostat
 
-    or
+or
 
     $ jc iostat
 

docs/parsers/iostat_s.md

@@ -130,4 +130,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ip_address.md

@@ -0,0 +1,555 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ip_address"></a>
+
+# jc.parsers.ip\_address
+
+jc - JSON Convert IP Address string parser
+
+Accepts standard and integer IP address notation for both IPv4 and IPv6
+addresses. CIDR subnet mask and Scope ID is also allowed for standard
+notation. See examples below.
+
+Usage (cli):
+
+    $ echo '192.168.1.1' | jc --ip-address
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ip_address', ip_address_string)
+
+Schema:
+
+    {
+      "version":                  integer,
+      "max_prefix_length":        integer,
+      "ip":                       string,
+      "ip_compressed":            string,
+      "ip_exploded":              string,
+      "ip_split": [
+                                  string
+      ],
+      "scope_id":                 string/null,
+      "ipv4_mapped":              string/null,
+      "six_to_four":              string/null,
+      "teredo_client":            string/null,
+      "teredo_server":            string/null,
+      "dns_ptr":                  string,
+      "network":                  string,
+      "broadcast":                string,
+      "hostmask":                 string,
+      "netmask":                  string,
+      "cidr_netmask":             integer,
+      "hosts":                    integer,
+      "first_host":               string,
+      "last_host":                string,
+      "is_multicast":             boolean,
+      "is_private":               boolean,
+      "is_global":                boolean,
+      "is_link_local":            boolean,
+      "is_loopback":              boolean,
+      "is_reserved":              boolean,
+      "is_unspecified":           boolean,
+      "int": {
+        "ip":                     integer,
+        "network":                integer,
+        "broadcast":              integer,
+        "first_host":             integer,
+        "last_host":              integer
+      },
+      "hex": {
+        "ip":                     string,
+        "network":                string,
+        "broadcast":              string,
+        "hostmask":               string,
+        "netmask":                string,
+        "first_host":             string,
+        "last_host":              string
+      },
+      "bin": {
+        "ip":                     string,
+        "network":                string,
+        "broadcast":              string,
+        "hostmask":               string,
+        "netmask":                string,
+        "first_host":             string,
+        "last_host":              string
+      }
+    }
+
+Examples:
+
+    $ echo 192.168.2.10/24 | jc --ip-address -p
+    {
+      "version": 4,
+      "max_prefix_length": 32,
+      "ip": "192.168.2.10",
+      "ip_compressed": "192.168.2.10",
+      "ip_exploded": "192.168.2.10",
+      "ip_split": [
+        "192",
+        "168",
+        "2",
+        "10"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "10.2.168.192.in-addr.arpa",
+      "network": "192.168.2.0",
+      "broadcast": "192.168.2.255",
+      "hostmask": "0.0.0.255",
+      "netmask": "255.255.255.0",
+      "cidr_netmask": 24,
+      "hosts": 254,
+      "first_host": "192.168.2.1",
+      "last_host": "192.168.2.254",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 3232236042,
+        "network": 3232236032,
+        "broadcast": 3232236287,
+        "first_host": 3232236033,
+        "last_host": 3232236286
+      },
+      "hex": {
+        "ip": "c0:a8:02:0a",
+        "network": "c0:a8:02:00",
+        "broadcast": "c0:a8:02:ff",
+        "hostmask": "00:00:00:ff",
+        "netmask": "ff:ff:ff:00",
+        "first_host": "c0:a8:02:01",
+        "last_host": "c0:a8:02:fe"
+      },
+      "bin": {
+        "ip": "11000000101010000000001000001010",
+        "network": "11000000101010000000001000000000",
+        "broadcast": "11000000101010000000001011111111",
+        "hostmask": "00000000000000000000000011111111",
+        "netmask": "11111111111111111111111100000000",
+        "first_host": "11000000101010000000001000000001",
+        "last_host": "11000000101010000000001011111110"
+      }
+    }
+
+    $ echo 3232236042 | jc --ip-address -p
+    {
+      "version": 4,
+      "max_prefix_length": 32,
+      "ip": "192.168.2.10",
+      "ip_compressed": "192.168.2.10",
+      "ip_exploded": "192.168.2.10",
+      "ip_split": [
+        "192",
+        "168",
+        "2",
+        "10"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "10.2.168.192.in-addr.arpa",
+      "network": "192.168.2.10",
+      "broadcast": "192.168.2.10",
+      "hostmask": "0.0.0.0",
+      "netmask": "255.255.255.255",
+      "cidr_netmask": 32,
+      "hosts": 1,
+      "first_host": "192.168.2.10",
+      "last_host": "192.168.2.10",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 3232236042,
+        "network": 3232236042,
+        "broadcast": 3232236042,
+        "first_host": 3232236042,
+        "last_host": 3232236042
+      },
+      "hex": {
+        "ip": "c0:a8:02:0a",
+        "network": "c0:a8:02:0a",
+        "broadcast": "c0:a8:02:0a",
+        "hostmask": "00:00:00:00",
+        "netmask": "ff:ff:ff:ff",
+        "first_host": "c0:a8:02:0a",
+        "last_host": "c0:a8:02:0a"
+      },
+      "bin": {
+        "ip": "11000000101010000000001000001010",
+        "network": "11000000101010000000001000001010",
+        "broadcast": "11000000101010000000001000001010",
+        "hostmask": "00000000000000000000000000000000",
+        "netmask": "11111111111111111111111111111111",
+        "first_host": "11000000101010000000001000001010",
+        "last_host": "11000000101010000000001000001010"
+      }
+    }
+
+    $ echo 127:0:de::1%128/96 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "127:0:de::1",
+      "ip_compressed": "127:0:de::1",
+      "ip_exploded": "0127:0000:00de:0000:0000:0000:0000:0001",
+      "ip_split": [
+        "0127",
+        "0000",
+        "00de",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0001"
+      ],
+      "scope_id": "128",
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "1.0.0.0.0.0...0.0.0.e.d.0.0.0.0.0.0.7.2.1.0.ip6.arpa",
+      "network": "127:0:de::",
+      "broadcast": "127:0:de::ffff:ffff",
+      "hostmask": "::ffff:ffff",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff::",
+      "cidr_netmask": 96,
+      "hosts": 4294967294,
+      "first_host": "127:0:de::1",
+      "last_host": "127:0:de::ffff:fffe",
+      "is_multicast": false,
+      "is_private": false,
+      "is_global": true,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": true,
+      "is_unspecified": false,
+      "int": {
+        "ip": 1531727573536155682370944093904699393,
+        "network": 1531727573536155682370944093904699392,
+        "broadcast": 1531727573536155682370944098199666687,
+        "first_host": 1531727573536155682370944093904699393,
+        "last_host": 1531727573536155682370944098199666686
+      },
+      "hex": {
+        "ip": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "network": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:00",
+        "broadcast": "01:27:00:00:00:de:00:00:00:00:00:00:ff:ff:ff:ff",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:ff:ff:ff:ff",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:00:00:00:00",
+        "first_host": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "last_host": "01:27:00:00:00:de:00:00:00:00:00:00:ff:ff:ff:fe"
+      },
+      "bin": {
+        "ip": "0000000100100111000000000000000000000000110...000000000001",
+        "network": "00000001001001110000000000000000000000...000000000000",
+        "broadcast": "000000010010011100000000000000000000...111111111111",
+        "hostmask": "0000000000000000000000000000000000000...111111111111",
+        "netmask": "11111111111111111111111111111111111111...000000000000",
+        "first_host": "00000001001001110000000000000000000...000000000001",
+        "last_host": "000000010010011100000000000000000000...1111111111110"
+      }
+    }
+
+    $ echo 1531727573536155682370944093904699393 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "127:0:de::1",
+      "ip_compressed": "127:0:de::1",
+      "ip_exploded": "0127:0000:00de:0000:0000:0000:0000:0001",
+      "ip_split": [
+        "0127",
+        "0000",
+        "00de",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0001"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "1.0.0.0.0.0....0.0.0.0.e.d.0.0.0.0.0.0.7.2.1.0.ip6.arpa",
+      "network": "127:0:de::1",
+      "broadcast": "127:0:de::1",
+      "hostmask": "::",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+      "cidr_netmask": 128,
+      "hosts": 1,
+      "first_host": "127:0:de::1",
+      "last_host": "127:0:de::1",
+      "is_multicast": false,
+      "is_private": false,
+      "is_global": true,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": true,
+      "is_unspecified": false,
+      "int": {
+        "ip": 1531727573536155682370944093904699393,
+        "network": 1531727573536155682370944093904699393,
+        "broadcast": 1531727573536155682370944093904699393,
+        "first_host": 1531727573536155682370944093904699393,
+        "last_host": 1531727573536155682370944093904699393
+      },
+      "hex": {
+        "ip": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "network": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "broadcast": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "first_host": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "last_host": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01"
+      },
+      "bin": {
+        "ip": "0000000100100111000000000000000000000000110111100...000001",
+        "network": "00000001001001110000000000000000000000001101...000001",
+        "broadcast": "000000010010011100000000000000000000000011...000001",
+        "hostmask": "0000000000000000000000000000000000000000000...000000",
+        "netmask": "11111111111111111111111111111111111111111111...111111",
+        "first_host": "00000001001001110000000000000000000000001...000001",
+        "last_host": "000000010010011100000000000000000000000011...0000001"
+      }
+    }
+
+    # IPv4 Mapped Address
+    $ echo ::FFFF:192.168.1.35 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "::ffff:c0a8:123",
+      "ip_compressed": "::ffff:c0a8:123",
+      "ip_exploded": "0000:0000:0000:0000:0000:ffff:c0a8:0123",
+      "ip_split": [
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "ffff",
+        "c0a8",
+        "0123"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": "192.168.1.35",
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "3.2.1.0.8.a.0.c.f.f.f.f.0.0....0.0.0.0.0.0.ip6.arpa",
+      "network": "::ffff:c0a8:123",
+      "broadcast": "::ffff:c0a8:123",
+      "hostmask": "::",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+      "cidr_netmask": 128,
+      "hosts": 1,
+      "first_host": "::ffff:c0a8:123",
+      "last_host": "::ffff:c0a8:123",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": true,
+      "is_unspecified": false,
+      "int": {
+        "ip": 281473913979171,
+        "network": 281473913979171,
+        "broadcast": 281473913979171,
+        "first_host": 281473913979171,
+        "last_host": 281473913979171
+      },
+      "hex": {
+        "ip": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "network": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "broadcast": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "first_host": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "last_host": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23"
+      },
+      "bin": {
+        "ip": "000000000000000000000000000000000000000000000...100100011",
+        "network": "0000000000000000000000000000000000000000...000100011",
+        "broadcast": "00000000000000000000000000000000000000...000100011",
+        "hostmask": "000000000000000000000000000000000000000...000000000",
+        "netmask": "1111111111111111111111111111111111111111...111111111",
+        "first_host": "0000000000000000000000000000000000000...100100011",
+        "last_host": "00000000000000000000000000000000000000...0100100011"
+      }
+    }
+
+    # 6to4 Address
+    $ echo 2002:c000:204::/48 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "2002:c000:204::",
+      "ip_compressed": "2002:c000:204::",
+      "ip_exploded": "2002:c000:0204:0000:0000:0000:0000:0000",
+      "ip_split": [
+        "2002",
+        "c000",
+        "0204",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0000"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": "192.0.2.4",
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "0.0.0.0.0.0.0...0.0.0.4.0.2.0.0.0.0.c.2.0.0.2.ip6.arpa",
+      "network": "2002:c000:204::",
+      "broadcast": "2002:c000:204:ffff:ffff:ffff:ffff:ffff",
+      "hostmask": "::ffff:ffff:ffff:ffff:ffff",
+      "netmask": "ffff:ffff:ffff::",
+      "cidr_netmask": 48,
+      "hosts": 1208925819614629174706174,
+      "first_host": "2002:c000:204::1",
+      "last_host": "2002:c000:204:ffff:ffff:ffff:ffff:fffe",
+      "is_multicast": false,
+      "is_private": false,
+      "is_global": true,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 42549574682102084431821433448024768512,
+        "network": 42549574682102084431821433448024768512,
+        "broadcast": 42549574682103293357641048077199474687,
+        "first_host": 42549574682102084431821433448024768513,
+        "last_host": 42549574682103293357641048077199474686
+      },
+      "hex": {
+        "ip": "20:02:c0:00:02:04:00:00:00:00:00:00:00:00:00:00",
+        "network": "20:02:c0:00:02:04:00:00:00:00:00:00:00:00:00:00",
+        "broadcast": "20:02:c0:00:02:04:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "hostmask": "00:00:00:00:00:00:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "netmask": "ff:ff:ff:ff:ff:ff:00:00:00:00:00:00:00:00:00:00",
+        "first_host": "20:02:c0:00:02:04:00:00:00:00:00:00:00:00:00:01",
+        "last_host": "20:02:c0:00:02:04:ff:ff:ff:ff:ff:ff:ff:ff:ff:fe"
+      },
+      "bin": {
+        "ip": "00100000000000101100000000000000000000100000010...00000000",
+        "network": "001000000000001011000000000000000000001000...00000000",
+        "broadcast": "0010000000000010110000000000000000000010...11111111",
+        "hostmask": "00000000000000000000000000000000000000000...11111111",
+        "netmask": "111111111111111111111111111111111111111111...00000000",
+        "first_host": "001000000000001011000000000000000000001...00000001",
+        "last_host": "0010000000000010110000000000000000000010...111111110"
+      }
+    }
+
+    # Teredo Address
+    $ echo 2001:0000:4136:e378:8000:63bf:3fff:fdd2 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "ip_compressed": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "ip_exploded": "2001:0000:4136:e378:8000:63bf:3fff:fdd2",
+      "ip_split": [
+        "2001",
+        "0000",
+        "4136",
+        "e378",
+        "8000",
+        "63bf",
+        "3fff",
+        "fdd2"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": "192.0.2.45",
+      "teredo_server": "65.54.227.120",
+      "dns_ptr": "2.d.d.f.f.f.f.3.f.b.3.6.0.0.0.8.8....0.1.0.0.2.ip6.arpa",
+      "network": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "broadcast": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "hostmask": "::",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+      "cidr_netmask": 128,
+      "hosts": 1,
+      "first_host": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "last_host": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 42540488182158724593221357832373272018,
+        "network": 42540488182158724593221357832373272018,
+        "broadcast": 42540488182158724593221357832373272018,
+        "first_host": 42540488182158724593221357832373272018,
+        "last_host": 42540488182158724593221357832373272018
+      },
+      "hex": {
+        "ip": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "network": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "broadcast": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "first_host": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "last_host": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2"
+      },
+      "bin": {
+        "ip": "0010000000000001000000000000000001000001001...110111010010",
+        "network": "00100000000000010000000000000000010000...110111010010",
+        "broadcast": "001000000000000100000000000000000100...110111010010",
+        "hostmask": "0000000000000000000000000000000000000...000000000000",
+        "netmask": "11111111111111111111111111111111111111...111111111111",
+        "first_host": "00100000000000010000000000000000010...110111010010",
+        "last_host": "001000000000000100000000000000000100...110111010010"
+      }
+    }
+
+<a id="jc.parsers.ip_address.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iptables.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ sudo iptables -L -t nat | jc --iptables
 
-    or
+or
 
     $ jc iptables -L -t nat
 

docs/parsers/iso_datetime.md

@@ -5,65 +5,10 @@
 
 jc - JSON Convert ISO 8601 Datetime string parser
 
-This parser supports standard ISO 8601 strings that include both date and
-time. If no timezone or offset information is available in the sring, then
-UTC timezone is used.
+This parser has been renamed to datetime-iso (cli) or datetime_iso (module).
 
-Usage (cli):
-
-    $ echo "2022-07-20T14:52:45Z" | jc --iso-datetime
-
-Usage (module):
-
-    import jc
-    result = jc.parse('iso_datetime', iso_8601_string)
-
-Schema:
-
-    {
-      "year":               integer,
-      "month":              string,
-      "month_num":          integer,
-      "day":                integer,
-      "weekday":            string,
-      "weekday_num":        integer,
-      "hour":               integer,
-      "hour_24":            integer,
-      "minute":             integer,
-      "second":             integer,
-      "microsecond":        integer,
-      "period":             string,
-      "utc_offset":         string,
-      "day_of_year":        integer,
-      "week_of_year":       integer,
-      "iso":                string,
-      "timestamp":          integer  # [0]
-    }
-
-    [0] timezone aware UNIX timestamp expressed in UTC
-
-Examples:
-
-    $ echo "2022-07-20T14:52:45Z" | jc --iso-datetime -p
-    {
-      "year": 2022,
-      "month": "Jul",
-      "month_num": 7,
-      "day": 20,
-      "weekday": "Wed",
-      "weekday_num": 3,
-      "hour": 2,
-      "hour_24": 14,
-      "minute": 52,
-      "second": 45,
-      "microsecond": 0,
-      "period": "PM",
-      "utc_offset": "+0000",
-      "day_of_year": 201,
-      "week_of_year": 29,
-      "iso": "2022-07-20T14:52:45+00:00",
-      "timestamp": 1658328765
-    }
+This parser will be removed in a future version, so please start using
+the new parser name.
 
 <a id="jc.parsers.iso_datetime.parse"></a>
 
@@ -73,7 +18,8 @@ Examples:
 def parse(data, raw=False, quiet=False)
 ```
 
-Main text parsing function
+This parser is deprecated and calls datetime_iso. Please use datetime_iso
+directly. This parser will be removed in the future.
 
 Parameters:
 
@@ -88,4 +34,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
 
-Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iw_scan.md

@@ -12,7 +12,7 @@ Usage (cli):
 
     $ iw dev wlan0 scan | jc --iw-scan
 
-    or
+or
 
     $ jc iw dev wlan0 scan
 

docs/parsers/iwconfig.md

@@ -0,0 +1,111 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iwconfig"></a>
+
+# jc.parsers.iwconfig
+
+jc - JSON Convert `iwconfig` command output parser
+
+No `iwconfig` options are supported.
+
+Usage (cli):
+
+    $ iwconfig | jc --iwconfig
+
+or
+
+    $ jc iwconfig
+
+Usage (module):
+
+    import jc
+    result = jc.parse('iwconfig', iwconfig_command_output)
+
+Schema:
+
+    [
+        {
+            "name":                         string,
+            "protocol":                     string,
+            "essid":                        string,
+            "mode":                         string,
+            "frequency":                    float,
+            "frequency_unit":               string,
+            "access_point":                 string,
+            "bit_rate":                     float,
+            "bit_rate_unit":                string,
+            "tx_power":                     integer,
+            "tx_power_unit":                string,
+            "retry_short_limit":            integer,
+            "rts_threshold":                boolean,
+            "fragment_threshold":           boolean,
+            "power_management":             boolean,
+            "link_quality":                 string,
+            "signal_level":                 integer,
+            "signal_level_unit":            string,
+            "rx_invalid_nwid":              integer,
+            "rx_invalid_crypt":             integer,
+            "rx_invalid_frag":              integer,
+            "tx_excessive_retries":         integer,
+            "invalid_misc":                 integer,
+            "missed_beacon":                integer
+        }
+    ]
+
+Examples:
+
+    $  iwconfig | jc --iwconfig -p
+    [
+      {
+        "name": "wlp5s0",
+        "protocol": "IEEE 802.11",
+        "essid": "BLABLABLA",
+        "mode": "Managed",
+        "frequency": 5.18,
+        "frequency_unit": "GHz",
+        "access_point": "E6:64:DA:16:51:BF",
+        "bit_rate": 6.0,
+        "bit_rate_unit": "Mb/s",
+        "tx_power": 30,
+        "tx_power_unit": "dBm",
+        "retry_short_limit": 7,
+        "rts_threshold": false,
+        "fragment_threshold": false,
+        "power_management": true,
+        "link_quality": "61/70",
+        "signal_level": -49,
+        "signal_level_unit": "dBm",
+        "rx_invalid_nwid": 0,
+        "rx_invalid_crypt": 0,
+        "rx_invalid_frag": 0,
+        "tx_excessive_retries": 0,
+        "invalid_misc": 2095,
+        "missed_beacon": 0
+      }
+    ]
+
+<a id="jc.parsers.iwconfig.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Thomas Vincent (vrince@gmail.com)

docs/parsers/jar_manifest.md

@@ -3,7 +3,7 @@
 
 # jc.parsers.jar\_manifest
 
-jc - JSON Convert `MANIFEST.MF` file parser
+jc - JSON Convert Java `MANIFEST.MF` file parser
 
 Usage (cli):
 

docs/parsers/kv.md

@@ -3,7 +3,7 @@
 
 # jc.parsers.kv
 
-jc - JSON Convert `Key/Value` file parser
+jc - JSON Convert `Key/Value` file and string parser
 
 Supports files containing simple key/value pairs.
 
@@ -26,8 +26,8 @@ Usage (module):
 
 Schema:
 
-key/value document converted to a dictionary - see the configparser standard
-library documentation for more details.
+Key/Value document converted to a dictionary - see the python configparser
+standard library documentation for more details.
 
     {
       "key1":       string,
@@ -41,6 +41,7 @@ Examples:
     name = John Doe
     address=555 California Drive
     age: 34
+
     ; comments can include # or ;
     # delimiter can be = or :
     # quoted values have quotation marks stripped by default
@@ -65,8 +66,6 @@ def parse(data, raw=False, quiet=False)
 
 Main text parsing function
 
-    Note: this is just a wrapper for jc.parsers.ini
-
 Parameters:
 
     data:        (string)  text data to parse
@@ -75,9 +74,9 @@ Parameters:
 
 Returns:
 
-    Dictionary representing the key/value file
+    Dictionary representing a Key/Value pair document.
 
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 2.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/last.md

@@ -15,7 +15,7 @@ Usage (cli):
 
     $ last | jc --last
 
-    or
+or
 
     $ jc last
 

docs/parsers/ls.md

@@ -26,7 +26,7 @@ Usage (cli):
 
     $ ls | jc --ls
 
-    or
+or
 
     $ jc ls
 

docs/parsers/ls_s.md

@@ -99,4 +99,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsblk.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ lsblk | jc --lsblk
 
-    or
+or
 
     $ jc lsblk
 

docs/parsers/lsmod.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ lsmod | jc --lsmod
 
-    or
+or
 
     $ jc lsmod
 

docs/parsers/lsof.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ lsof | jc --lsof
 
-    or
+or
 
     $ jc lsof
 
@@ -140,6 +140,6 @@ Returns:
     List of Dictionaries. Raw or processed structured data.
 
 ### Parser Information
-Compatibility:  linux
+Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lspci.md

@@ -0,0 +1,148 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lspci"></a>
+
+# jc.parsers.lspci
+
+jc - JSON Convert `lspci -mmv` command output parser
+
+This parser supports the following `lspci` options:
+- `-mmv`
+- `-nmmv`
+- `-nnmmv`
+
+Usage (cli):
+
+    $ lspci -nnmmv | jc --lspci
+
+or
+
+    $ jc lspci -nnmmv
+
+Usage (module):
+
+    import jc
+    result = jc.parse('lspci', lspci_command_output)
+
+Schema:
+
+    [
+      {
+        "slot":                         string,
+        "domain":                       string,
+        "domain_int":                   integer,
+        "bus":                          string,
+        "bus_int":                      integer,
+        "dev":                          string,
+        "dev_int":                      integer,
+        "function":                     string,
+        "function_int":                 integer,
+        "class":                        string,
+        "class_id":                     string,
+        "class_id_int":                 integer,
+        "vendor":                       string,
+        "vendor_id":                    string,
+        "vendor_id_int":                integer,
+        "device":                       string,
+        "device_id":                    string,
+        "device_id_int":                integer,
+        "svendor":                      string,
+        "svendor_id":                   string,
+        "svendor_id_int":               integer,
+        "sdevice":                      string,
+        "sdevice_id":                   string,
+        "sdevice_id_int":               integer,
+        "rev":                          string,
+        "physlot":                      string,
+        "physlot_int":                  integer,
+        "progif":                       string,
+        "progif_int":                   integer
+      }
+    ]
+
+Examples:
+
+    $ lspci -nnmmv | jc --lspci -p
+    [
+      {
+        "slot": "ff:02:05.0",
+        "domain": "ff",
+        "domain_int": 255,
+        "bus": "02",
+        "bus_int": 2,
+        "dev": "05",
+        "dev_int": 5,
+        "function": "0",
+        "function_int": 0,
+        "class": "SATA controller",
+        "class_id": "0106",
+        "class_id_int": 262,
+        "vendor": "VMware",
+        "vendor_id": "15ad",
+        "vendor_id_int": 5549,
+        "device": "SATA AHCI controller",
+        "device_id": "07e0",
+        "device_id_int": 2016,
+        "svendor": "VMware",
+        "svendor_id": "15ad",
+        "svendor_id_int": 5549,
+        "sdevice": "SATA AHCI controller",
+        "sdevice_id": "07e0",
+        "sdevice_id_int": 2016,
+        "physlot": "37",
+        "physlot_int": 55,
+        "progif": "01",
+        "progif_int": 1
+      },
+      ...
+    ]
+
+    $ lspci -nnmmv | jc --lspci -p -r
+    [
+      {
+        "slot": "ff:02:05.0",
+        "domain": "ff",
+        "bus": "02",
+        "dev": "05",
+        "function": "0",
+        "class": "SATA controller",
+        "class_id": "0106",
+        "vendor": "VMware",
+        "vendor_id": "15ad",
+        "device": "SATA AHCI controller",
+        "device_id": "07e0",
+        "svendor": "VMware",
+        "svendor_id": "15ad",
+        "sdevice": "SATA AHCI controller",
+        "sdevice_id": "07e0",
+        "physlot": "37",
+        "progif": "01"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.lspci.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsusb.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ lsusb -v | jc --lsusb
 
-    or
+or
 
     $ jc lsusb -v
 
@@ -102,6 +102,28 @@ Schema:
                     ]
                   }
                 },
+                "videocontrol_descriptors": [
+                  {
+                    "<item>": {
+                      "value":                string,
+                      "description":          string,
+                      "attributes": [
+                                              string
+                      ]
+                    }
+                  }
+                ],
+                "videostreaming_descriptors": [
+                  {
+                    "<item>": {
+                      "value":                string,
+                      "description":          string,
+                      "attributes": [
+                                              string
+                      ]
+                    }
+                  }
+                ],
                 "endpoint_descriptors": [
                   {
                     "<item>": {
@@ -134,6 +156,12 @@ Schema:
             }
           }
         },
+        "device_qualifier": {
+          "<item>": {
+            "value":                          string,
+            "description":                    string
+          }
+        },
         "device_status": {
           "value":                            string,
           "description":                      string
@@ -284,4 +312,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mdadm.md

@@ -0,0 +1,252 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mdadm"></a>
+
+# jc.parsers.mdadm
+
+jc - JSON Convert `mdadm` command output parser
+
+Supports the `--query` and `--examine` options in `mdadm`.
+
+Usage (cli):
+
+    $ mdadm --query --detail /dev/md0 | jc --mdadm
+
+or
+
+    $ mdadm --examine -E /dev/sdb1 | jc --mdadm
+
+or
+
+    $ jc mdadm --query --detail /dev/md0
+
+or
+
+    $ jc mdadm --examine -E /dev/sdb1
+
+Usage (module):
+
+    import jc
+    result = jc.parse('mdadm', mdadm_command_output)
+
+Schema:
+
+    {
+      "device":                       string,
+      "magic":                        string,
+      "version":                      string,
+      "feature_map":                  string,
+      "array_uuid":                   string,
+      "name":                         string,
+      "name_val":                     string,
+      "uuid":                         string,
+      "uuid_val":                     string,
+      "homehost":                     string,
+      "container":                    string,
+      "container_dev":                string,
+      "container_member":             integer,
+      "controller_guid":              string,
+      "container_guid":               string,
+      "seq":                          string,
+      "redundant_hdr":                string,
+      "virtual_disks":                integer,
+      "creation_time":                string,
+      "creation_time_epoch":          integer,  # naive timestamp
+      "raid_level":                   string,
+      "array_size":                   string,
+      "array_size_num":               integer,
+      "used_dev_size":                string,
+      "used_dev_size_num":            integer,
+      "raid_devices":                 integer,
+      "avail_dev_size":               string,
+      "avail_dev_size_num":           integer,
+      "data_offset":                  integer,
+      "super_offset":                 integer,
+      "unused_space":                 string,
+      "unused_space_before":          integer,
+      "unused_space_after":           integer,
+      "state":                        string,
+      "state_list": [
+                                      string
+      ],
+      "device_uuid":                  string,
+      "flags":                        string,
+      "flag_list": [
+                                      string
+      ],
+      "update_time":                  string,
+      "update_time_epoch":            integer,  # naive timestamp
+      "bad_block_log":                string,
+      "checksum":                     string,
+      "checksum_val":                 string,
+      "checksum_state":               string,
+      "events":                       string,
+      "events_num":                   integer,
+      "events_maj":                   integer,
+      "events_min":                   integer,
+      "chunk_size":                   string,
+      "chunk_size_num":               integer,
+      "device_role":                  string,
+      "array_state":                  string,
+      "array_state_list": [
+                                      string
+      ],
+      "member_arrays":                string,
+      "member_arrays_list": [
+                                      string
+      ],
+      "consistency_policy":           string,
+      "rebuild_status":               string,
+      "rebuild_status_percent":       integer,
+      "resync_status":                string,
+      "resync_status_percent":        integer,
+      "check_status":                 string,
+      "check_status_percent":         integer,
+      "total_devices":                integer,
+      "preferred_minor":              integer,
+      "persistence":                  string,
+      "active_devices":               integer,
+      "working_devices":              integer,
+      "failed_devices":               integer,
+      "spare_devices":                integer,
+      "physical_disks":               integer,
+      "device_table": [
+        {
+          "number":                   integer/null,
+          "major":                    integer/null,
+          "minor":                    integer/null,
+          "state": [
+                                      string
+          ],
+          "device":                   string,
+          "raid_device":              integer/null
+        }
+      ]
+    }
+
+    Any fields unspecified above will be string type.
+
+Examples:
+
+    $ mdadm --query --detail /dev/md0 | jc --mdadm -p
+    {
+      "device": "/dev/md0",
+      "version": "1.1",
+      "creation_time": "Tue Apr 13 23:22:16 2010",
+      "raid_level": "raid1",
+      "array_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "used_dev_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "raid_devices": 2,
+      "total_devices": 2,
+      "persistence": "Superblock is persistent",
+      "intent_bitmap": "Internal",
+      "update_time": "Tue Jul 26 20:16:31 2022",
+      "state": "clean",
+      "active_devices": 2,
+      "working_devices": 2,
+      "failed_devices": 0,
+      "spare_devices": 0,
+      "consistency_policy": "bitmap",
+      "name": "virttest:0",
+      "uuid": "85c5b164:d58a5ada:14f5fe07:d642e843",
+      "events": 2193679,
+      "device_table": [
+        {
+          "number": 3,
+          "major": 8,
+          "minor": 17,
+          "state": [
+            "active",
+            "sync"
+          ],
+          "device": "/dev/sdb1",
+          "raid_device": 0
+        },
+        {
+          "number": 2,
+          "major": 8,
+          "minor": 33,
+          "state": [
+            "active",
+            "sync"
+          ],
+          "device": "/dev/sdc1",
+          "raid_device": 1
+        }
+      ],
+      "array_size_num": 5860520828,
+      "used_dev_size_num": 5860520828,
+      "name_val": "virttest:0",
+      "uuid_val": "85c5b164:d58a5ada:14f5fe07:d642e843",
+      "state_list": [
+        "clean"
+      ],
+      "creation_time_epoch": 1271226136,
+      "update_time_epoch": 1658891791
+    }
+
+    $ mdadm --query --detail /dev/md0 | jc --mdadm -p -r
+    {
+      "device": "/dev/md0",
+      "version": "1.1",
+      "creation_time": "Tue Apr 13 23:22:16 2010",
+      "raid_level": "raid1",
+      "array_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "used_dev_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "raid_devices": "2",
+      "total_devices": "2",
+      "persistence": "Superblock is persistent",
+      "intent_bitmap": "Internal",
+      "update_time": "Tue Jul 26 20:16:31 2022",
+      "state": "clean",
+      "active_devices": "2",
+      "working_devices": "2",
+      "failed_devices": "0",
+      "spare_devices": "0",
+      "consistency_policy": "bitmap",
+      "name": "virttest:0",
+      "uuid": "85c5b164:d58a5ada:14f5fe07:d642e843",
+      "events": "2193679",
+      "device_table": [
+        {
+          "number": "3",
+          "major": "8",
+          "minor": "17",
+          "state": "active sync",
+          "device": "/dev/sdb1",
+          "raid_device": "0"
+        },
+        {
+          "number": "2",
+          "major": "8",
+          "minor": "33",
+          "state": "active sync",
+          "device": "/dev/sdc1",
+          "raid_device": "1"
+        }
+      ]
+    }
+
+<a id="jc.parsers.mdadm.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mount.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ mount | jc --mount
 
-    or
+or
 
     $ jc mount
 
@@ -25,7 +25,7 @@ Schema:
         "filesystem":       string,
         "mount_point":      string,
         "type":             string,
-        "access": [
+        "options": [
                             string
         ]
       }
@@ -39,7 +39,7 @@ Example:
         "filesystem": "sysfs",
         "mount_point": "/sys",
         "type": "sysfs",
-        "access": [
+        "options": [
           "rw",
           "nosuid",
           "nodev",
@@ -51,7 +51,7 @@ Example:
         "filesystem": "proc",
         "mount_point": "/proc",
         "type": "proc",
-        "access": [
+        "options": [
           "rw",
           "nosuid",
           "nodev",
@@ -63,7 +63,7 @@ Example:
         "filesystem": "udev",
         "mount_point": "/dev",
         "type": "devtmpfs",
-        "access": [
+        "options": [
           "rw",
           "nosuid",
           "relatime",
@@ -96,6 +96,6 @@ Returns:
     List of Dictionaries. Raw or processed structured data.
 
 ### Parser Information
-Compatibility:  linux, darwin, freebsd
+Compatibility:  linux, darwin, freebsd, aix
 
-Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mpstat.md

@@ -11,7 +11,7 @@ Usage (cli):
 
     $ mpstat | jc --mpstat
 
-    or
+or
 
     $ jc mpstat
 

docs/parsers/netstat.md

@@ -14,7 +14,7 @@ Usage (cli):
 
     $ netstat | jc --netstat
 
-    or
+or
 
     $ jc netstat
 

docs/parsers/nmcli.md

@@ -18,7 +18,7 @@ Usage (cli):
 
     $ nmcli device show lo | jc --nmcli
 
-    or
+or
 
     $ jc nmcli device show lo
 

docs/parsers/ntpq.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ ntpq -p | jc --ntpq
 
-    or
+or
 
     $ jc ntpq -p
 

docs/parsers/openvpn.md

@@ -0,0 +1,178 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.openvpn"></a>
+
+# jc.parsers.openvpn
+
+jc - JSON Convert openvpn-status.log file parser
+
+The `*_epoch` calculated timestamp fields are naive. (i.e. based on
+the local time of the system the parser is run on)
+
+Usage (cli):
+
+    $ cat openvpn-status.log | jc --openvpn
+
+Usage (module):
+
+    import jc
+    result = jc.parse('openvpn', openvpn_status_log_file_output)
+
+Schema:
+
+    {
+      "clients": [
+        {
+          "common_name":                        string,
+          "real_address":                       string,
+          "real_address_prefix":                integer,  # [0]
+          "real_address_port":                  integer,  # [0]
+          "bytes_received":                     integer,
+          "bytes_sent":                         integer,
+          "connected_since":                    string,
+          "connected_since_epoch":              integer,
+          "updated":                            string,
+          "updated_epoch":                      integer,
+        }
+      ],
+      "routing_table": [
+        {
+          "virtual_address":                    string,
+          "virtual_address_prefix":             integer,  # [0]
+          "virtual_address_port":               integer,  # [0]
+          "common_name":                        string,
+          "real_address":                       string,
+          "real_address_prefix":                integer,  # [0]
+          "real_address_port":                  integer,  # [0]
+          "last_reference":                     string,
+          "last_reference_epoch":               integer,
+        }
+      ],
+      "global_stats": {
+        "max_bcast_mcast_queue_len":            integer
+      }
+    }
+
+    [0] null/None if not found
+
+Examples:
+
+    $ cat openvpn-status.log | jc --openvpn -p
+    {
+      "clients": [
+        {
+          "common_name": "foo@example.com",
+          "real_address": "10.10.10.10",
+          "bytes_received": 334948,
+          "bytes_sent": 1973012,
+          "connected_since": "Thu Jun 18 04:23:03 2015",
+          "updated": "Thu Jun 18 08:12:15 2015",
+          "real_address_prefix": null,
+          "real_address_port": 49502,
+          "connected_since_epoch": 1434626583,
+          "updated_epoch": 1434640335
+        },
+        {
+          "common_name": "foo@example.com",
+          "real_address": "10.10.10.10",
+          "bytes_received": 334948,
+          "bytes_sent": 1973012,
+          "connected_since": "Thu Jun 18 04:23:03 2015",
+          "updated": "Thu Jun 18 08:12:15 2015",
+          "real_address_prefix": null,
+          "real_address_port": 49503,
+          "connected_since_epoch": 1434626583,
+          "updated_epoch": 1434640335
+        }
+      ],
+      "routing_table": [
+        {
+          "virtual_address": "192.168.255.118",
+          "common_name": "baz@example.com",
+          "real_address": "10.10.10.10",
+          "last_reference": "Thu Jun 18 08:12:09 2015",
+          "virtual_address_prefix": null,
+          "virtual_address_port": null,
+          "real_address_prefix": null,
+          "real_address_port": 63414,
+          "last_reference_epoch": 1434640329
+        },
+        {
+          "virtual_address": "10.200.0.0",
+          "common_name": "baz@example.com",
+          "real_address": "10.10.10.10",
+          "last_reference": "Thu Jun 18 08:12:09 2015",
+          "virtual_address_prefix": 16,
+          "virtual_address_port": null,
+          "real_address_prefix": null,
+          "real_address_port": 63414,
+          "last_reference_epoch": 1434640329
+        }
+      ],
+      "global_stats": {
+        "max_bcast_mcast_queue_len": 0
+      }
+    }
+
+    $ cat openvpn-status.log | jc --openvpn -p -r
+    {
+      "clients": [
+        {
+          "common_name": "foo@example.com",
+          "real_address": "10.10.10.10:49502",
+          "bytes_received": "334948",
+          "bytes_sent": "1973012",
+          "connected_since": "Thu Jun 18 04:23:03 2015",
+          "updated": "Thu Jun 18 08:12:15 2015"
+        },
+        {
+          "common_name": "foo@example.com",
+          "real_address": "10.10.10.10:49503",
+          "bytes_received": "334948",
+          "bytes_sent": "1973012",
+          "connected_since": "Thu Jun 18 04:23:03 2015",
+          "updated": "Thu Jun 18 08:12:15 2015"
+        }
+      ],
+      "routing_table": [
+        {
+          "virtual_address": "192.168.255.118",
+          "common_name": "baz@example.com",
+          "real_address": "10.10.10.10:63414",
+          "last_reference": "Thu Jun 18 08:12:09 2015"
+        },
+        {
+          "virtual_address": "10.200.0.0/16",
+          "common_name": "baz@example.com",
+          "real_address": "10.10.10.10:63414",
+          "last_reference": "Thu Jun 18 08:12:09 2015"
+        }
+      ],
+      "global_stats": {
+        "max_bcast_mcast_queue_len": "0"
+      }
+    }
+
+<a id="jc.parsers.openvpn.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/os_prober.md

@@ -0,0 +1,66 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.os_prober"></a>
+
+# jc.parsers.os\_prober
+
+jc - JSON Convert `os-prober` command output parser
+
+Usage (cli):
+
+    $ os-prober | jc --os-prober
+
+or
+
+    $ jc os-prober
+
+Usage (module):
+
+    import jc
+    result = jc.parse('os_prober', os_prober_command_output)
+
+Schema:
+
+    {
+      "partition":              string,
+      "efi_bootmgr":            string,  # [0]
+      "name":                   string,
+      "short_name":             string,
+      "type":                   string
+    }
+
+    [0] only exists if an EFI boot manager is detected
+
+Examples:
+
+    $ os-prober | jc --os-prober -p
+    {
+      "partition": "/dev/sda1",
+      "name": "Windows 10",
+      "short_name": "Windows",
+      "type": "chain"
+    }
+
+<a id="jc.parsers.os_prober.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pci_ids.md

@@ -0,0 +1,99 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pci_ids"></a>
+
+# jc.parsers.pci\_ids
+
+jc - JSON Convert `pci.ids` file parser
+
+This parser converts the pci.ids database file.
+
+https://raw.githubusercontent.com/pciutils/pciids/master/pci.ids
+
+A nested schema allows straightforward queries with tools like `jq`. Hex id
+numbers are prefixed with an underscore (`_`) so bracket notation is not
+necessary when referencing. For example:
+
+    $ cat pci.ids | jc --pci-ids | jq '.vendors._9005._0053._9005._ffff.subsystem_name'
+    "AIC-7896 SCSI Controller mainboard implementation"
+
+Here are the vendor and class mappings:
+
+    jq '.vendors._001c._0001._001c._0005.subsystem_name'
+                  |     |     |     |
+                  |     |     |     subdevice
+                  |     |     subvendor
+                  |     device
+                  vendor
+
+    jq '.classes._0c._03._40'
+                  |   |   |
+                  |   |   prog_if
+                  |   subclass
+                  class
+
+Usage (cli):
+
+    $ cat pci.ids | jc --pci-ids
+
+Usage (module):
+
+    import jc
+    result = jc.parse('pci_ids', pci_ids_file_output)
+
+Schema:
+
+    {
+      "vendors": {
+        "_<vendor_id>": {
+          "vendor_name":                 string,
+          "_<device_id>": {
+            "device_name":               string,
+            "_<subvendor_id>": {
+              "_<subdevice_id":          string
+            }
+          }
+        }
+      },
+      "classes": {
+        "_<class_id>": {
+          "class_name":                  string,
+          "_<subclass_id>": {
+            "subclass_name":             string,
+            "_<prog_if>":                string
+          }
+        }
+      }
+    }
+
+Examples:
+
+    $ cat pci.ids | jc --pci-ids | jq '.vendors._001c._0001._001c._0005.subsystem_name'
+    "2 Channel CAN Bus SJC1000 (Optically Isolated)"
+
+    $ cat pci.ids | jc --pci-ids | jq '.classes._0c._03._40'
+    "USB4 Host Interface"
+
+<a id="jc.parsers.pci_ids.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pgpass.md

@@ -0,0 +1,75 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pgpass"></a>
+
+# jc.parsers.pgpass
+
+jc - JSON Convert PostgreSQL password file parser
+
+Usage (cli):
+
+    $ cat /var/lib/postgresql/.pgpass | jc --pgpass
+
+Usage (module):
+
+    import jc
+    result = jc.parse('pgpass', postgres_password_file)
+
+Schema:
+
+    [
+      {
+        "hostname":               string,
+        "port":                   string,
+        "database":               string,
+        "username":               string,
+        "password":               string
+      }
+    ]
+
+Examples:
+
+    $ cat /var/lib/postgresql/.pgpass | jc --pgpass -p
+    [
+      {
+        "hostname": "dbserver",
+        "port": "*",
+        "database": "db1",
+        "username": "dbuser",
+        "password": "pwd123"
+      },
+      {
+        "hostname": "dbserver2",
+        "port": "8888",
+        "database": "inventory",
+        "username": "joe:user",
+        "password": "abc123"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.pgpass.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pidstat.md

@@ -3,18 +3,18 @@
 
 # jc.parsers.pidstat
 
-jc - JSON Convert `pidstat -h` command output parser
+jc - JSON Convert `pidstat -H` command output parser
 
-Must use the `-h` option in `pidstat`. All other `pidstat` options are
-supported in combination with `-h`.
+Must use the `-H` (or `-h`, if `-H` is not available) option in `pidstat`.
+All other `pidstat` options are supported in combination with this option.
 
 Usage (cli):
 
-    $ pidstat -h | jc --pidstat
+    $ pidstat -H | jc --pidstat
 
-    or
+or
 
-    $ jc pidstat -h
+    $ jc pidstat -H
 
 Usage (module):
 
@@ -51,7 +51,7 @@ Schema:
 
 Examples:
 
-    $ pidstat -hl | jc --pidstat -p
+    $ pidstat -Hl | jc --pidstat -p
     [
       {
         "time": 1646859134,
@@ -88,7 +88,7 @@ Examples:
       }
     ]
 
-    $ pidstat -hl | jc --pidstat -p -r
+    $ pidstat -Hl | jc --pidstat -p -r
     [
       {
         "time": "1646859134",

docs/parsers/pidstat_s.md

@@ -3,17 +3,17 @@
 
 # jc.parsers.pidstat\_s
 
-jc - JSON Convert `pidstat -h` command output streaming parser
+jc - JSON Convert `pidstat -H` command output streaming parser
 
 > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
 > Dictionaries (module)
 
-Must use the `-h` option in `pidstat`. All other `pidstat` options are
-supported in combination with `-h`.
+Must use the `-H` (or `-h`, if `-H` is not available) option in `pidstat`.
+All other `pidstat` options are supported in combination with this option.
 
 Usage (cli):
 
-    $ pidstat | jc --pidstat-s
+    $ pidstat -H | jc --pidstat-s
 
 > Note: When piping `jc` converted `pidstat` output to other processes it
 > may appear the output is hanging due to the OS pipe buffers. This is
@@ -65,13 +65,13 @@ Schema:
 
 Examples:
 
-    $ pidstat -hl | jc --pidstat-s
+    $ pidstat -Hl | jc --pidstat-s
     {"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_syste...}
     {"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_syste...}
     {"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_syste...}
     ...
 
-    $ pidstat -hl | jc --pidstat-s -r
+    $ pidstat -Hl | jc --pidstat-s -r
     {"time":"1646859134","uid":"0","pid":"1","percent_usr":"0.00","perc...}
     {"time":"1646859134","uid":"0","pid":"6","percent_usr":"0.00","perc...}
     {"time":"1646859134","uid":"0","pid":"9","percent_usr":"0.00","perc...}

docs/parsers/ping.md

@@ -14,7 +14,7 @@ Usage (cli):
 
     $ ping -c 3 1.2.3.4 | jc --ping
 
-    or
+or
 
     $ jc ping -c 3 1.2.3.4
 

docs/parsers/ping_s.md

@@ -106,4 +106,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_list.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ pip list | jc --pip-list
 
-    or
+or
 
     $ jc pip list
 

docs/parsers/pip_show.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ pip show | jc --pip-show
 
-    or
+or
 
     $ jc pip show
 

docs/parsers/plist.md

@@ -0,0 +1,77 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.plist"></a>
+
+# jc.parsers.plist
+
+jc - JSON Convert PLIST file parser
+
+Converts binary, XML, and NeXTSTEP PLIST files.
+
+Binary values are converted into an ASCII hex representation.
+
+Datetime objects are converted into Unix epoch timestamps and ISO strings.
+The timestamp and ISO string will maintain the same naive or timezone-aware
+properties as the object in the original PLIST file.
+
+Usage (cli):
+
+    $ cat file.plist | jc --plist
+
+Usage (module):
+
+    import jc
+    result = jc.parse('plist', plist_file_output)
+
+Schema:
+
+    {
+      "<key>":            string/integer/float/boolean/object/array/null
+    }
+
+Examples:
+
+    $ cat info.plist | jc --plist -p
+    {
+      "NSAppleScriptEnabled": true,
+      "LSMultipleInstancesProhibited": true,
+      "CFBundleInfoDictionaryVersion": "6.0",
+      "DTPlatformVersion": "GM",
+      "CFBundleIconFile": "GarageBand.icns",
+      "CFBundleName": "GarageBand",
+      "DTSDKName": "macosx10.13internal",
+      "NSSupportsAutomaticGraphicsSwitching": true,
+      "RevisionDate": "2018-12-03_14:10:56",
+      "UTImportedTypeDeclarations": [
+        {
+          "UTTypeConformsTo": [
+            "public.data",
+            "public.content"
+      ...
+    }
+
+<a id="jc.parsers.plist.parse"></a>
+
+### parse
+
+```python
+def parse(data: Union[str, bytes],
+          raw: bool = False,
+          quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/postconf.md

@@ -9,7 +9,7 @@ Usage (cli):
 
     $ postconf -M | jc --postconf
 
-    or
+or
 
     $ jc postconf -M
 

docs/parsers/proc.md

@@ -0,0 +1,142 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc"></a>
+
+# jc.parsers.proc
+
+jc - JSON Convert Proc file output parser
+
+This parser automatically identifies the Proc file and calls the
+corresponding parser to perform the parsing.
+
+Magic syntax for converting `/proc` files is also supported by running
+`jc /proc/<path to file>`. Any `jc` options must be specified before the
+`/proc` path.
+
+specific Proc file parsers can also be called directly, if desired and have
+a naming convention of `proc-<name>` (cli) or `proc_<name>` (module).
+
+Usage (cli):
+
+    $ cat /proc/meminfo | jc --proc
+
+or
+
+    $ jc /proc/meminfo
+
+or
+
+    $ cat /proc/meminfo | jc --proc-memifno
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_file)
+
+Schema:
+
+See the specific Proc parser for the schema:
+
+    $ jc --help --proc-<name>
+
+For example:
+
+    $ jc --help --proc-meminfo
+
+Specific Proc file parser names can be found with `jc -hh` or `jc -a`.
+
+Schemas can also be found online at:
+
+    https://kellyjonbrazil.github.io/jc/docs/parsers/proc_<name>
+
+For example:
+
+    https://kellyjonbrazil.github.io/jc/docs/parsers/proc_meminfo
+
+Examples:
+
+    $ cat /proc/modules | jc --proc -p
+    [
+      {
+        "module": "binfmt_misc",
+        "size": 24576,
+        "used": 1,
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0ab4000"
+      },
+      {
+        "module": "vsock_loopback",
+        "size": 16384,
+        "used": 0,
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0a14000"
+      },
+      {
+        "module": "vmw_vsock_virtio_transport_common",
+        "size": 36864,
+        "used": 1,
+        "used_by": [
+          "vsock_loopback"
+        ],
+        "status": "Live",
+        "location": "0xffffffffc0a03000"
+      },
+      ...
+    ]
+
+    $ cat /proc/modules | jc --proc-modules -p -r
+    [
+      {
+        "module": "binfmt_misc",
+        "size": "24576",
+        "used": "1",
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0ab4000"
+      },
+      {
+        "module": "vsock_loopback",
+        "size": "16384",
+        "used": "0",
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0a14000"
+      },
+      {
+        "module": "vmw_vsock_virtio_transport_common",
+        "size": "36864",
+        "used": "1",
+        "used_by": [
+          "vsock_loopback"
+        ],
+        "status": "Live",
+        "location": "0xffffffffc0a03000"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_buddyinfo.md

@@ -0,0 +1,128 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_buddyinfo"></a>
+
+# jc.parsers.proc\_buddyinfo
+
+jc - JSON Convert `/proc/buddyinfo` file parser
+
+Usage (cli):
+
+    $ cat /proc/buddyinfo | jc --proc
+
+or
+
+    $ jc /proc/buddyinfo
+
+or
+
+    $ cat /proc/buddyinfo | jc --proc-buddyinfo
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_buddyinfo_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_buddyinfo', proc_buddyinfo_file)
+
+Schema:
+
+All values are integers.
+
+    [
+      {
+        "node":               integer,
+        "zone":               string,
+        "free_chunks": [
+                              integer  # [0]
+        ]
+      }
+    ]
+
+    [0] array index correlates to the Order number.
+        E.g. free_chunks[0] is the value for Order 0
+
+
+Examples:
+
+    $ cat /proc/buddyinfo | jc --proc -p
+    [
+      {
+        "node": 0,
+        "zone": "DMA",
+        "free_chunks": [
+          0,
+          0,
+          0,
+          1,
+          1,
+          1,
+          1,
+          1,
+          0,
+          1,
+          3
+        ]
+      },
+      {
+        "node": 0,
+        "zone": "DMA32",
+        "free_chunks": [
+          78,
+          114,
+          82,
+          52,
+          38,
+          25,
+          13,
+          9,
+          3,
+          4,
+          629
+        ]
+      },
+      {
+        "node": 0,
+        "zone": "Normal",
+        "free_chunks": [
+          0,
+          22,
+          8,
+          10,
+          1,
+          1,
+          2,
+          11,
+          13,
+          0,
+          0
+        ]
+      }
+    ]
+
+<a id="jc.parsers.proc_buddyinfo.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_consoles.md

@@ -0,0 +1,111 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_consoles"></a>
+
+# jc.parsers.proc\_consoles
+
+jc - JSON Convert `/proc/consoles` file parser
+
+Usage (cli):
+
+    $ cat /proc/consoles | jc --proc
+
+or
+
+    $ jc /proc/consoles
+
+or
+
+    $ cat /proc/consoles | jc --proc-consoles
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_consoles_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_consoles', proc_consoles_file)
+
+Schema:
+
+    [
+      {
+        "device":                     string,
+        "operations":                 string,
+        "operations_list": [
+                                      string  # [0]
+        ],
+        "flags":                      string,
+        "flags_list": [
+                                      string  # [1]
+        ],
+        "major":                      integer,
+        "minor":                      integer
+      }
+    ]
+
+    [0] Values: read, write, unblank
+    [1] Values: enabled, preferred, primary boot, prink buffer,
+                braille device, safe when CPU offline
+
+Examples:
+
+    $ cat /proc/consoles | jc --proc -p
+    [
+      {
+        "device": "tty0",
+        "operations": "-WU",
+        "operations_list": [
+          "write",
+          "unblank"
+        ],
+        "flags": "ECp",
+        "flags_list": [
+          "enabled",
+          "preferred",
+          "printk buffer"
+        ],
+        "major": 4,
+        "minor": 7
+      },
+      {
+        "device": "ttyS0",
+        "operations": "-W-",
+        "operations_list": [
+          "write"
+        ],
+        "flags": "Ep",
+        "flags_list": [
+          "enabled",
+          "printk buffer"
+        ],
+        "major": 4,
+        "minor": 64
+      }
+    ]
+
+<a id="jc.parsers.proc_consoles.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_cpuinfo.md

@@ -0,0 +1,247 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_cpuinfo"></a>
+
+# jc.parsers.proc\_cpuinfo
+
+jc - JSON Convert `/proc/cpuinfo` file parser
+
+Usage (cli):
+
+    $ cat /proc/cpuinfo | jc --proc
+
+or
+
+    $ jc /proc/cpuinfo
+
+or
+
+    $ cat /proc/cpuinfo | jc --proc-cpuinfo
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_cpuinfo_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_cpuinfo', proc_cpuinfo_file)
+
+Schema:
+
+Integer, float, and boolean ("yes"/"no") conversions are attempted. Blank
+strings are converted to `null`.
+
+"Well-known" keys like `cache size`, `address types`, `bugs`, and `flags`
+are processed into sensible data types. (see below)
+
+If this is not desired, then use the `--raw` (CLI) or `raw=True` (Module)
+option.
+
+    [
+      {
+        "processor":                  integer,
+        "address sizes":              string,
+        "address_size_physical":      integer,  # in bits
+        "address_size_virtual":       integer,  # in bits
+        "cache size":                 string,
+        "cache_size_num":             integer,
+        "cache_size_unit":            string,
+        "flags": [
+                                      string
+        ],
+        "bugs": [
+                                      string
+        ],
+        "bogomips":                   float,
+        <key>:                        string/int/float/boolean/null
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/cpuinfo | jc --proc -p
+    [
+      {
+        "processor": 0,
+        "vendor_id": "GenuineIntel",
+        "cpu family": 6,
+        "model": 142,
+        "model name": "Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz",
+        "stepping": 10,
+        "cpu MHz": 2400.0,
+        "cache size": "6144 KB",
+        "physical id": 0,
+        "siblings": 1,
+        "core id": 0,
+        "cpu cores": 1,
+        "apicid": 0,
+        "initial apicid": 0,
+        "fpu": true,
+        "fpu_exception": true,
+        "cpuid level": 22,
+        "wp": true,
+        "bogomips": 4800.0,
+        "clflush size": 64,
+        "cache_alignment": 64,
+        "address sizes": "45 bits physical, 48 bits virtual",
+        "power management": null,
+        "address_size_physical": 45,
+        "address_size_virtual": 48,
+        "cache_size_num": 6144,
+        "cache_size_unit": "KB",
+        "flags": [
+          "fpu",
+          "vme",
+          "de",
+          "pse",
+          "tsc",
+          "msr",
+          "pae",
+          "mce",
+          "cx8",
+          "apic",
+          "sep",
+          "mtrr",
+          "pge",
+          "mca",
+          "cmov",
+          "pat",
+          "pse36",
+          "clflush",
+          "mmx",
+          "fxsr",
+          "sse",
+          "sse2",
+          "ss",
+          "syscall",
+          "nx",
+          "pdpe1gb",
+          "rdtscp",
+          "lm",
+          "constant_tsc",
+          "arch_perfmon",
+          "nopl",
+          "xtopology",
+          "tsc_reliable",
+          "nonstop_tsc",
+          "cpuid",
+          "pni",
+          "pclmulqdq",
+          "ssse3",
+          "fma",
+          "cx16",
+          "pcid",
+          "sse4_1",
+          "sse4_2",
+          "x2apic",
+          "movbe",
+          "popcnt",
+          "tsc_deadline_timer",
+          "aes",
+          "xsave",
+          "avx",
+          "f16c",
+          "rdrand",
+          "hypervisor",
+          "lahf_lm",
+          "abm",
+          "3dnowprefetch",
+          "cpuid_fault",
+          "invpcid_single",
+          "pti",
+          "ssbd",
+          "ibrs",
+          "ibpb",
+          "stibp",
+          "fsgsbase",
+          "tsc_adjust",
+          "bmi1",
+          "avx2",
+          "smep",
+          "bmi2",
+          "invpcid",
+          "rdseed",
+          "adx",
+          "smap",
+          "clflushopt",
+          "xsaveopt",
+          "xsavec",
+          "xgetbv1",
+          "xsaves",
+          "arat",
+          "md_clear",
+          "flush_l1d",
+          "arch_capabilities"
+        ],
+        "bugs": [
+          "cpu_meltdown",
+          "spectre_v1",
+          "spectre_v2",
+          "spec_store_bypass",
+          "l1tf",
+          "mds",
+          "swapgs",
+          "itlb_multihit",
+          "srbds"
+        ]
+      },
+      ...
+    ]
+
+    $ cat /proc/cpuinfo | jc --proc_cpuinfo -p -r
+    [
+      {
+        "processor": "0",
+        "vendor_id": "GenuineIntel",
+        "cpu family": "6",
+        "model": "142",
+        "model name": "Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz",
+        "stepping": "10",
+        "cpu MHz": "2400.000",
+        "cache size": "6144 KB",
+        "physical id": "0",
+        "siblings": "1",
+        "core id": "0",
+        "cpu cores": "1",
+        "apicid": "0",
+        "initial apicid": "0",
+        "fpu": "yes",
+        "fpu_exception": "yes",
+        "cpuid level": "22",
+        "wp": "yes",
+        "flags": "fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge ...",
+        "bugs": "cpu_meltdown spectre_v1 spectre_v2 spec_store_bypass ...",
+        "bogomips": "4800.00",
+        "clflush size": "64",
+        "cache_alignment": "64",
+        "address sizes": "45 bits physical, 48 bits virtual",
+        "power management": ""
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_cpuinfo.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_crypto.md

@@ -0,0 +1,143 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_crypto"></a>
+
+# jc.parsers.proc\_crypto
+
+jc - JSON Convert `/proc/crypto` file parser
+
+Usage (cli):
+
+    $ cat /proc/crypto | jc --proc
+
+or
+
+    $ jc /proc/crypto
+
+or
+
+    $ cat /proc/crypto | jc --proc-crypto
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_crypto_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_crypto', proc_crypto_file)
+
+Schema:
+
+"Well-known" keys like `priority` and `refcnt` are converted to integers.
+Also, keynames ending in "size" are converted to integers.
+
+If this is not desired, then use the `--raw` (CLI) or `raw=True` (Module)
+option.
+
+    [
+      {
+        "name":                   string,
+        "driver":                 string,
+        "module":                 string,
+        "priority":               integer,
+        "refcnt":                 integer,
+        "selftest":               string,
+        "internal":               string,
+        "type":                   string,
+        "*size":                  integer
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/crypto | jc --proc -p
+    [
+      {
+        "name": "ecdh",
+        "driver": "ecdh-generic",
+        "module": "ecdh_generic",
+        "priority": 100,
+        "refcnt": 1,
+        "selftest": "passed",
+        "internal": "no",
+        "type": "kpp"
+      },
+      {
+        "name": "blake2b-512",
+        "driver": "blake2b-512-generic",
+        "module": "blake2b_generic",
+        "priority": 100,
+        "refcnt": 1,
+        "selftest": "passed",
+        "internal": "no",
+        "type": "shash",
+        "blocksize": 128,
+        "digestsize": 64
+      },
+      ...
+    ]
+
+    $ cat /proc/crypto | jc --proc_crypto -p -r
+    [
+      {
+        "name": "ecdh",
+        "driver": "ecdh-generic",
+        "module": "ecdh_generic",
+        "priority": "100",
+        "refcnt": "1",
+        "selftest": "passed",
+        "internal": "no",
+        "type": "kpp"
+      },
+      {
+        "name": "blake2b-512",
+        "driver": "blake2b-512-generic",
+        "module": "blake2b_generic",
+        "priority": "100",
+        "refcnt": "1",
+        "selftest": "passed",
+        "internal": "no",
+        "type": "shash",
+        "blocksize": "128",
+        "digestsize": "64"
+      },
+      {
+        "name": "blake2b-384",
+        "driver": "blake2b-384-generic",
+        "module": "blake2b_generic",
+        "priority": "100",
+        "refcnt": "1",
+        "selftest": "passed",
+        "internal": "no",
+        "type": "shash",
+        "blocksize": "128",
+        "digestsize": "48"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_crypto.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_devices.md

@@ -0,0 +1,103 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_devices"></a>
+
+# jc.parsers.proc\_devices
+
+jc - JSON Convert `/proc/devices` file parser
+
+Usage (cli):
+
+    $ cat /proc/devices | jc --proc
+
+or
+
+    $ jc /proc/devices
+
+or
+
+    $ cat /proc/devices | jc --proc-devices
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_devices_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_devices', proc_devices_file)
+
+Schema:
+
+Since devices can be members of multiple groups, the value for each device
+is a list.
+
+    {
+      "character": {
+        "<device number>": [
+                                    string
+        ]
+      },
+      "block": {
+        "<device number>": [
+                                    string
+        ]
+      }
+    }
+
+Examples:
+
+    $ cat /proc/devices | jc --proc -p
+    {
+      "character": {
+        "1": [
+          "mem"
+        ],
+        "4": [
+          "/dev/vc/0",
+          "tty",
+          "ttyS"
+        ],
+        "5": [
+          "/dev/tty",
+          "/dev/console",
+          "/dev/ptmx",
+          "ttyprintk"
+        ],
+      "block": {
+        "7": [
+          "loop"
+        ],
+        "8": [
+          "sd"
+        ],
+        "9": [
+          "md"
+        ]
+      }
+    }
+
+<a id="jc.parsers.proc_devices.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_diskstats.md

@@ -0,0 +1,202 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_diskstats"></a>
+
+# jc.parsers.proc\_diskstats
+
+jc - JSON Convert `/proc/diskstats` file parser
+
+Usage (cli):
+
+    $ cat /proc/diskstats | jc --proc
+
+or
+
+    $ jc /proc/diskstats
+
+or
+
+    $ cat /proc/diskstats | jc --proc-diskstats
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_diskstats_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_diskstats', proc_diskstats_file)
+
+Schema:
+
+    [
+      {
+        "maj":                                          integer,
+        "min":                                          integer,
+        "device":                                       string,
+        "reads_completed":                              integer,
+        "reads_merged":                                 integer,
+        "sectors_read":                                 integer,
+        "read_time_ms":                                 integer,
+        "writes_completed":                             integer,
+        "writes_merged":                                integer,
+        "sectors_written":                              integer,
+        "write_time_ms":                                integer,
+        "io_in_progress":                               integer,
+        "io_time_ms":                                   integer,
+        "weighted_io_time_ms":                          integer,
+        "discards_completed_successfully":              integer,
+        "discards_merged":                              integer,
+        "sectors_discarded":                            integer,
+        "discarding_time_ms":                           integer,
+        "flush_requests_completed_successfully":        integer,
+        "flushing_time_ms":                             integer
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/diskstats | jc --proc -p
+    [
+      {
+        "maj": 7,
+        "min": 0,
+        "device": "loop0",
+        "reads_completed": 48,
+        "reads_merged": 0,
+        "sectors_read": 718,
+        "read_time_ms": 19,
+        "writes_completed": 0,
+        "writes_merged": 0,
+        "sectors_written": 0,
+        "write_time_ms": 0,
+        "io_in_progress": 0,
+        "io_time_ms": 36,
+        "weighted_io_time_ms": 19,
+        "discards_completed_successfully": 0,
+        "discards_merged": 0,
+        "sectors_discarded": 0,
+        "discarding_time_ms": 0,
+        "flush_requests_completed_successfully": 0,
+        "flushing_time_ms": 0
+      },
+      {
+        "maj": 7,
+        "min": 1,
+        "device": "loop1",
+        "reads_completed": 41,
+        "reads_merged": 0,
+        "sectors_read": 688,
+        "read_time_ms": 17,
+        "writes_completed": 0,
+        "writes_merged": 0,
+        "sectors_written": 0,
+        "write_time_ms": 0,
+        "io_in_progress": 0,
+        "io_time_ms": 28,
+        "weighted_io_time_ms": 17,
+        "discards_completed_successfully": 0,
+        "discards_merged": 0,
+        "sectors_discarded": 0,
+        "discarding_time_ms": 0,
+        "flush_requests_completed_successfully": 0,
+        "flushing_time_ms": 0
+      },
+      ...
+    ]
+
+    $ cat /proc/diskstats | jc --proc_diskstats -p -r
+    [
+      {
+        "maj": "7",
+        "min": "0",
+        "device": "loop0",
+        "reads_completed": "48",
+        "reads_merged": "0",
+        "sectors_read": "718",
+        "read_time_ms": "19",
+        "writes_completed": "0",
+        "writes_merged": "0",
+        "sectors_written": "0",
+        "write_time_ms": "0",
+        "io_in_progress": "0",
+        "io_time_ms": "36",
+        "weighted_io_time_ms": "19",
+        "discards_completed_successfully": "0",
+        "discards_merged": "0",
+        "sectors_discarded": "0",
+        "discarding_time_ms": "0",
+        "flush_requests_completed_successfully": "0",
+        "flushing_time_ms": "0"
+      },
+      {
+        "maj": "7",
+        "min": "1",
+        "device": "loop1",
+        "reads_completed": "41",
+        "reads_merged": "0",
+        "sectors_read": "688",
+        "read_time_ms": "17",
+        "writes_completed": "0",
+        "writes_merged": "0",
+        "sectors_written": "0",
+        "write_time_ms": "0",
+        "io_in_progress": "0",
+        "io_time_ms": "28",
+        "weighted_io_time_ms": "17",
+        "discards_completed_successfully": "0",
+        "discards_merged": "0",
+        "sectors_discarded": "0",
+        "discarding_time_ms": "0",
+        "flush_requests_completed_successfully": "0",
+        "flushing_time_ms": "0"
+      },
+      {
+        "maj": "7",
+        "min": "2",
+        "device": "loop2",
+        "reads_completed": "119",
+        "reads_merged": "0",
+        "sectors_read": "2956",
+        "read_time_ms": "18",
+        "writes_completed": "0",
+        "writes_merged": "0",
+        "sectors_written": "0",
+        "write_time_ms": "0",
+        "io_in_progress": "0",
+        "io_time_ms": "56",
+        "weighted_io_time_ms": "18",
+        "discards_completed_successfully": "0",
+        "discards_merged": "0",
+        "sectors_discarded": "0",
+        "discarding_time_ms": "0",
+        "flush_requests_completed_successfully": "0",
+        "flushing_time_ms": "0"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_diskstats.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_driver_rtc.md

@@ -0,0 +1,126 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_driver_rtc"></a>
+
+# jc.parsers.proc\_driver\_rtc
+
+jc - JSON Convert `/proc/driver/rtc` file parser
+
+Usage (cli):
+
+    $ cat /proc/driver/rtc | jc --proc
+
+or
+
+    $ jc /proc/driver/rtc
+
+or
+
+    $ cat /proc/driver/rtc | jc --proc-driver-rtc
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_driver_rtc_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_driver_rtc', proc_driver_rtc_file)
+
+Schema:
+
+"yes" and "no" values are converted to `true`/`false`. Integer conversions
+are attempted. If you do not want this behavior, then use `--raw` (cli) or
+`raw=True` (module).
+
+    {
+      "rtc_time":                       string,
+      "rtc_date":                       string,
+      "alrm_time":                      string,
+      "alrm_date":                      string,
+      "alarm_IRQ":                      boolean,
+      "alrm_pending":                   boolean,
+      "update IRQ enabled":             boolean,
+      "periodic IRQ enabled":           boolean,
+      "periodic IRQ frequency":         integer,
+      "max user IRQ frequency":         integer,
+      "24hr":                           boolean,
+      "periodic_IRQ":                   boolean,
+      "update_IRQ":                     boolean,
+      "HPET_emulated":                  boolean,
+      "BCD":                            boolean,
+      "DST_enable":                     boolean,
+      "periodic_freq":                  integer,
+      "batt_status":                    string
+    }
+
+Examples:
+
+    $ cat /proc/driver/rtc | jc --proc -p
+    {
+      "rtc_time": "16:09:21",
+      "rtc_date": "2022-09-03",
+      "alrm_time": "00:00:00",
+      "alrm_date": "2022-09-03",
+      "alarm_IRQ": false,
+      "alrm_pending": false,
+      "update IRQ enabled": false,
+      "periodic IRQ enabled": false,
+      "periodic IRQ frequency": 1024,
+      "max user IRQ frequency": 64,
+      "24hr": true,
+      "periodic_IRQ": false,
+      "update_IRQ": false,
+      "HPET_emulated": true,
+      "BCD": true,
+      "DST_enable": false,
+      "periodic_freq": 1024,
+      "batt_status": "okay"
+    }
+
+    $ cat /proc/driver/rtc | jc --proc -p -r
+    {
+      "rtc_time": "16:09:21",
+      "rtc_date": "2022-09-03",
+      "alrm_time": "00:00:00",
+      "alrm_date": "2022-09-03",
+      "alarm_IRQ": "no",
+      "alrm_pending": "no",
+      "update IRQ enabled": "no",
+      "periodic IRQ enabled": "no",
+      "periodic IRQ frequency": "1024",
+      "max user IRQ frequency": "64",
+      "24hr": "yes",
+      "periodic_IRQ": "no",
+      "update_IRQ": "no",
+      "HPET_emulated": "yes",
+      "BCD": "yes",
+      "DST_enable": "no",
+      "periodic_freq": "1024",
+      "batt_status": "okay"
+    }
+
+<a id="jc.parsers.proc_driver_rtc.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_filesystems.md

@@ -0,0 +1,81 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_filesystems"></a>
+
+# jc.parsers.proc\_filesystems
+
+jc - JSON Convert `/proc/filesystems` file parser
+
+Usage (cli):
+
+    $ cat /proc/filesystems | jc --proc
+
+or
+
+    $ jc /proc/filesystems
+
+or
+
+    $ cat /proc/filesystems | jc --proc-filesystems
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_filesystems_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_filesystems', proc_filesystems_file)
+
+Schema:
+
+    [
+      {
+        "filesystem":               string,
+        "nodev":                    boolean
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/filesystems | jc --proc -p
+    [
+      {
+          "filesystem": "sysfs",
+          "nodev": true
+      },
+      {
+          "filesystem": "tmpfs",
+          "nodev": true
+      },
+      {
+          "filesystem": "bdev",
+          "nodev": true
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_filesystems.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_interrupts.md

@@ -0,0 +1,133 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_interrupts"></a>
+
+# jc.parsers.proc\_interrupts
+
+jc - JSON Convert `/proc/interrupts` file parser
+
+Usage (cli):
+
+    $ cat /proc/interrupts | jc --proc
+
+or
+
+    $ jc /proc/interrupts
+
+or
+
+    $ cat /proc/interrupts | jc --proc-interrupts
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_interrupts_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_interrupts', proc_interrupts_file)
+
+Schema:
+
+    [
+      {
+        "irq":                      string,
+        "cpu_num":                  integer,
+        "interrupts": [
+                                    integer
+        ],
+        "type":                     string,
+        "device": [
+                                    string
+        ]
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/interrupts | jc --proc -p
+    [
+      {
+        "irq": "0",
+        "cpu_num": 2,
+        "interrupts": [
+          18,
+          0
+        ],
+        "type": "IO-APIC",
+        "device": [
+          "2-edge",
+          "timer"
+        ]
+      },
+      {
+        "irq": "1",
+        "cpu_num": 2,
+        "interrupts": [
+          0,
+          73
+        ],
+        "type": "IO-APIC",
+        "device": [
+          "1-edge",
+          "i8042"
+        ]
+      },
+      ...
+    ]
+
+    $ cat /proc/interrupts | jc --proc-interrupts -p -r
+    [
+      {
+        "irq": "0",
+        "cpu_num": 2,
+        "interrupts": [
+          "18",
+          "0"
+        ],
+        "type": "IO-APIC",
+        "device": [
+          "2-edge",
+          "timer"
+        ]
+      },
+      {
+        "irq": "1",
+        "cpu_num": 2,
+        "interrupts": [
+          "0",
+          "73"
+        ],
+        "type": "IO-APIC",
+        "device": [
+          "1-edge",
+          "i8042"
+        ]
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_interrupts.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_iomem.md

@@ -0,0 +1,85 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_iomem"></a>
+
+# jc.parsers.proc\_iomem
+
+jc - JSON Convert `/proc/iomem` file parser
+
+Usage (cli):
+
+    $ cat /proc/iomem | jc --proc
+
+or
+
+    $ jc /proc/iomem
+
+or
+
+    $ cat /proc/iomem | jc --proc-iomem
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_iomem_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_iomem', proc_iomem_file)
+
+Schema:
+
+    [
+      {
+        "start":                   string,
+        "end":                     string,
+        "device":                  string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/iomem | jc --proc -p
+    [
+      {
+        "start": "00000000",
+        "end": "00000fff",
+        "device": "Reserved"
+      },
+      {
+        "start": "00001000",
+        "end": "0009e7ff",
+        "device": "System RAM"
+      },
+      {
+        "start": "0009e800",
+        "end": "0009ffff",
+        "device": "Reserved"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_iomem.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_ioports.md

@@ -0,0 +1,85 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_ioports"></a>
+
+# jc.parsers.proc\_ioports
+
+jc - JSON Convert `/proc/ioports` file parser
+
+Usage (cli):
+
+    $ cat /proc/ioports | jc --proc
+
+or
+
+    $ jc /proc/ioports
+
+or
+
+    $ cat /proc/ioports | jc --proc-ioports
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_ioports_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_ioports', proc_ioports_file)
+
+Schema:
+
+    [
+      {
+        "start":                   string,
+        "end":                     string,
+        "device":                  string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/ioports | jc --proc -p
+    [
+      {
+        "start": "0000",
+        "end": "0cf7",
+        "device": "PCI Bus 0000:00"
+      },
+      {
+        "start": "0000",
+        "end": "001f",
+        "device": "dma1"
+      },
+      {
+        "start": "0020",
+        "end": "0021",
+        "device": "PNP0001:00"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_ioports.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_loadavg.md

@@ -0,0 +1,88 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_loadavg"></a>
+
+# jc.parsers.proc\_loadavg
+
+jc - JSON Convert `/proc/loadavg` file parser
+
+Usage (cli):
+
+    $ cat /proc/loadavg | jc --proc
+
+or
+
+    $ jc /proc/loadavg
+
+or
+
+    $ cat /proc/loadavg | jc --proc-loadavg
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_loadavg_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_loadavg', proc_loadavg_file)
+
+Schema:
+
+All values are integers.
+
+    {
+      "load_1m":              float,
+      "load_5m":              float,
+      "load_15m":             float,
+      "running":              integer,
+      "available":            integer,
+      "last_pid":             integer
+    }
+
+Examples:
+
+    $ cat /proc/loadavg | jc --proc -p
+    {
+      "load_1m": 0.0,
+      "load_5m": 0.01,
+      "load_15m": 0.03,
+      "running": 2,
+      "available": 111,
+      "last_pid": 2039
+    }
+
+    $ cat /proc/loadavg | jc --proc -p -r
+    {
+      "load_1m": "0.00",
+      "load_5m": "0.01",
+      "load_15m": "0.03",
+      "running": "2",
+      "available": "111",
+      "last_pid": "2039"
+    }
+
+<a id="jc.parsers.proc_loadavg.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_locks.md

@@ -0,0 +1,130 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_locks"></a>
+
+# jc.parsers.proc\_locks
+
+jc - JSON Convert `/proc/locks` file parser
+
+Usage (cli):
+
+    $ cat /proc/locks | jc --proc
+
+or
+
+    $ jc /proc/locks
+
+or
+
+    $ cat /proc/locks | jc --proc-locks
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_locks_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_locks', proc_locks_file)
+
+Schema:
+
+    [
+      {
+        "id":                   integer,
+        "class":                string,
+        "type":                 string,
+        "access":               string,
+        "pid":                  integer,
+        "maj":                  string,
+        "min":                  string,
+        "inode":                integer,
+        "start":                string,
+        "end":                  string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/locks | jc --proc -p
+    [
+      {
+        "id": 1,
+        "class": "POSIX",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": 877,
+        "maj": "00",
+        "min": "19",
+        "inode": 812,
+        "start": "0",
+        "end": "EOF"
+      },
+      {
+        "id": 2,
+        "class": "FLOCK",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": 854,
+        "maj": "00",
+        "min": "19",
+        "inode": 805,
+        "start": "0",
+        "end": "EOF"
+      },
+      ...
+    ]
+
+    $ cat /proc/locks | jc --proc-locks -p -r
+    [
+      {
+        "id": "1",
+        "class": "POSIX",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": "877",
+        "maj": "00",
+        "min": "19",
+        "inode": "812",
+        "start": "0",
+        "end": "EOF"
+      },
+      {
+        "id": "2",
+        "class": "FLOCK",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": "854",
+        "maj": "00",
+        "min": "19",
+        "inode": "805",
+        "start": "0",
+        "end": "EOF"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_locks.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_meminfo.md

@@ -0,0 +1,118 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_meminfo"></a>
+
+# jc.parsers.proc\_meminfo
+
+jc - JSON Convert `/proc/meminfo` file parser
+
+Usage (cli):
+
+    $ cat /proc/meminfo | jc --proc
+
+or
+
+    $ jc /proc/meminfo
+
+or
+
+    $ cat /proc/meminfo | jc --proc-meminfo
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_meminfo_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_meminfo', proc_meminfo_file)
+
+Schema:
+
+All values are integers.
+
+    {
+      <keyName>             integer
+    }
+
+Examples:
+
+    $ cat /proc/meminfo | jc --proc -p
+    {
+      "MemTotal": 3997272,
+      "MemFree": 2760316,
+      "MemAvailable": 3386876,
+      "Buffers": 40452,
+      "Cached": 684856,
+      "SwapCached": 0,
+      "Active": 475816,
+      "Inactive": 322064,
+      "Active(anon)": 70216,
+      "Inactive(anon)": 148,
+      "Active(file)": 405600,
+      "Inactive(file)": 321916,
+      "Unevictable": 19476,
+      "Mlocked": 19476,
+      "SwapTotal": 3996668,
+      "SwapFree": 3996668,
+      "Dirty": 152,
+      "Writeback": 0,
+      "AnonPages": 92064,
+      "Mapped": 79464,
+      "Shmem": 1568,
+      "KReclaimable": 188216,
+      "Slab": 288096,
+      "SReclaimable": 188216,
+      "SUnreclaim": 99880,
+      "KernelStack": 5872,
+      "PageTables": 1812,
+      "NFS_Unstable": 0,
+      "Bounce": 0,
+      "WritebackTmp": 0,
+      "CommitLimit": 5995304,
+      "Committed_AS": 445240,
+      "VmallocTotal": 34359738367,
+      "VmallocUsed": 21932,
+      "VmallocChunk": 0,
+      "Percpu": 107520,
+      "HardwareCorrupted": 0,
+      "AnonHugePages": 0,
+      "ShmemHugePages": 0,
+      "ShmemPmdMapped": 0,
+      "FileHugePages": 0,
+      "FilePmdMapped": 0,
+      "HugePages_Total": 0,
+      "HugePages_Free": 0,
+      "HugePages_Rsvd": 0,
+      "HugePages_Surp": 0,
+      "Hugepagesize": 2048,
+      "Hugetlb": 0,
+      "DirectMap4k": 192320,
+      "DirectMap2M": 4001792,
+      "DirectMap1G": 2097152
+    }
+
+<a id="jc.parsers.proc_meminfo.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_modules.md

@@ -0,0 +1,132 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_modules"></a>
+
+# jc.parsers.proc\_modules
+
+jc - JSON Convert `/proc/modules` file parser
+
+Usage (cli):
+
+    $ cat /proc/modules | jc --proc
+
+or
+
+    $ jc /proc/modules
+
+or
+
+    $ cat /proc/modules | jc --proc-modules
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_modules_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_modules', proc_modules_file)
+
+Schema:
+
+    [
+      {
+        "module":                   string,
+        "size":                     integer,
+        "used":                     integer,
+        "used_by": [
+                                    string
+        ],
+        "status":                   string,
+        "location":                 string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/modules | jc --proc -p
+    [
+      {
+        "module": "binfmt_misc",
+        "size": 24576,
+        "used": 1,
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0ab4000"
+      },
+      {
+        "module": "vsock_loopback",
+        "size": 16384,
+        "used": 0,
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0a14000"
+      },
+      {
+        "module": "vmw_vsock_virtio_transport_common",
+        "size": 36864,
+        "used": 1,
+        "used_by": [
+          "vsock_loopback"
+        ],
+        "status": "Live",
+        "location": "0xffffffffc0a03000"
+      },
+      ...
+    ]
+
+    $ cat /proc/modules | jc --proc-modules -p -r
+    [
+      {
+        "module": "binfmt_misc",
+        "size": "24576",
+        "used": "1",
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0ab4000"
+      },
+      {
+        "module": "vsock_loopback",
+        "size": "16384",
+        "used": "0",
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0a14000"
+      },
+      {
+        "module": "vmw_vsock_virtio_transport_common",
+        "size": "36864",
+        "used": "1",
+        "used_by": [
+          "vsock_loopback"
+        ],
+        "status": "Live",
+        "location": "0xffffffffc0a03000"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_modules.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_mtrr.md

@@ -0,0 +1,111 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_mtrr"></a>
+
+# jc.parsers.proc\_mtrr
+
+jc - JSON Convert `/proc/mtrr` file parser
+
+Usage (cli):
+
+    $ cat /proc/mtrr | jc --proc
+
+or
+
+    $ jc /proc/mtrr
+
+or
+
+    $ cat /proc/mtrr | jc --proc-mtrr
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_mtrr_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_mtrr', proc_mtrr_file)
+
+Schema:
+
+    [
+      {
+        "register":             string,
+        "type":                 string,
+        "base":                 string,
+        "base_mb":              integer,
+        "size":                 integer,
+        "count":                integer,
+        "<key>":                string  # additional key/values are strings
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/mtrr | jc --proc -p
+    [
+      {
+        "register": "reg00",
+        "type": "write-back",
+        "base": "0x000000000",
+        "base_mb": 0,
+        "size": 2048,
+        "count": 1
+      },
+      {
+        "register": "reg01",
+        "type": "write-back",
+        "base": "0x080000000",
+        "base_mb": 2048,
+        "size": 1024,
+        "count": 1
+      },
+      ...
+    ]
+
+    $ cat /proc/mtrr | jc --proc-mtrr -p -r
+    [
+      {
+        "register": "reg00",
+        "type": "write-back",
+        "base": "0x000000000",
+        "base_mb": "0",
+        "size": "2048MB",
+        "count": "1"
+      },
+      {
+        "register": "reg01",
+        "type": "write-back",
+        "base": "0x080000000",
+        "base_mb": "2048",
+        "size": "1024MB",
+        "count": "1"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_mtrr.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_net_arp.md

@@ -0,0 +1,81 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_net_arp"></a>
+
+# jc.parsers.proc\_net\_arp
+
+jc - JSON Convert `/proc/net/arp` file parser
+
+Usage (cli):
+
+    $ cat /proc/net/arp | jc --proc
+
+or
+
+    $ jc /proc/net/arp
+
+or
+
+    $ cat /proc/net/arp | jc --proc-net-arp
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_net_arp_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_net_arp', proc_net_arp_file)
+
+Schema:
+
+    [
+      {
+        "IP_address":           string,
+        "HW_type":              string,
+        "Flags":                string,
+        "HW_address":           string,
+        "Mask":                 string,
+        "Device":               string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/net/arp | jc --proc -p
+    [
+      {
+        "IP_address": "192.168.71.254",
+        "HW_type": "0x1",
+        "Flags": "0x2",
+        "HW_address": "00:50:56:f3:2f:ae",
+        "Mask": "*",
+        "Device": "ens33"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_net_arp.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_net_dev.md

@@ -0,0 +1,127 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_net_dev"></a>
+
+# jc.parsers.proc\_net\_dev
+
+jc - JSON Convert `/proc/net/dev` file parser
+
+Usage (cli):
+
+    $ cat /proc/net/dev | jc --proc
+
+or
+
+    $ jc /proc/net/dev
+
+or
+
+    $ cat /proc/net/dev | jc --proc-net-dev
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_net_dev_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_net_dev', proc_net_dev_file)
+
+Schema:
+
+    [
+      {
+        "interface":                  string,
+        "r_bytes":                    integer,
+        "r_packets":                  integer,
+        "r_errs":                     integer,
+        "r_drop":                     integer,
+        "r_fifo":                     integer,
+        "r_frame":                    integer,
+        "r_compressed":               integer,
+        "r_multicast":                integer,
+        "t_bytes":                    integer,
+        "t_packets":                  integer,
+        "t_errs":                     integer,
+        "t_drop":                     integer,
+        "t_fifo":                     integer,
+        "t_colls":                    integer,
+        "t_carrier":                  integer,
+        "t_compressed":               integer
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/net/dev | jc --proc -p
+    [
+      {
+        "interface": "lo",
+        "r_bytes": 13222,
+        "r_packets": 152,
+        "r_errs": 0,
+        "r_drop": 0,
+        "r_fifo": 0,
+        "r_frame": 0,
+        "r_compressed": 0,
+        "r_multicast": 0,
+        "t_bytes": 13222,
+        "t_packets": 152,
+        "t_errs": 0,
+        "t_drop": 0,
+        "t_fifo": 0,
+        "t_colls": 0,
+        "t_carrier": 0,
+        "t_compressed": 0
+      },
+      ...
+    ]
+
+    $ cat /proc/net/dev | jc --proc-net-dev -p -r
+    [
+      {
+        "interface": "lo:",
+        "r_bytes": "13222",
+        "r_packets": "152",
+        "r_errs": "0",
+        "r_drop": "0",
+        "r_fifo": "0",
+        "r_frame": "0",
+        "r_compressed": "0",
+        "r_multicast": "0",
+        "t_bytes": "13222",
+        "t_packets": "152",
+        "t_errs": "0",
+        "t_drop": "0",
+        "t_fifo": "0",
+        "t_colls": "0",
+        "t_carrier": "0",
+        "t_compressed": "0"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_net_dev.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)