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

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2025-05-10 11:25:41 -07:00
parent 7c9e92e284
commit a854f1d6b0
9 changed files with 85 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1379,4 +1379,4 @@ cat istio.yaml | jc -p --yaml
] ]
``` ```
© 2019-2024 Kelly Brazil © 2019-2025 Kelly Brazil

2
docs/parsers/bluetoothctl.md
View File

@ -136,4 +136,4 @@ Compatibility: linux
Source: [`jc/parsers/bluetoothctl.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/bluetoothctl.py) Source: [`jc/parsers/bluetoothctl.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/bluetoothctl.py)
Version 1.3 by Jake Ob (iakopap at gmail.com) Version 1.4 by Jake Ob (iakopap at gmail.com)

11
docs/parsers/iptables.md
View File

@ -25,6 +25,9 @@ Schema:
[ [
{ {
"chain": string, "chain": string,
"default_policy": string,
"default_packets": integer,
"default_bytes": integer,
"rules": [ "rules": [
{ {
"num" integer, "num" integer,
@ -49,6 +52,9 @@ Examples:
[ [
{ {
"chain": "PREROUTING", "chain": "PREROUTING",
"default_policy": "DROP",
"default_packets": 0,
"default_bytes": 0,
"rules": [ "rules": [
{ {
"num": 1, "num": 1,
@ -108,6 +114,9 @@ Examples:
[ [
{ {
"chain": "PREROUTING", "chain": "PREROUTING",
"default_policy": "DROP",
"default_packets": "0",
"default_bytes": "0",
"rules": [ "rules": [
{ {
"num": "1", "num": "1",
@ -188,4 +197,4 @@ Compatibility: linux
Source: [`jc/parsers/iptables.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/iptables.py) Source: [`jc/parsers/iptables.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/iptables.py)
Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com)

107
docs/parsers/lsblk.md
View File

@ -22,46 +22,53 @@ Schema:
[ [
{ {
"name": string, "name": string,
"maj_min": string, "maj_min": string,
"rm": boolean, "rm": boolean,
"size": string, "size": string,
"ro": boolean, "size_bytes": integer
"type": string, "ro": boolean,
"mountpoint": string, "type": string,
"kname": string, "mountpoint": string,
"fstype": string, "mountpoints": [
"label": string, string
"uuid": string, ],
"partlabel": string, "kname": string,
"partuuid": string, "fstype": string,
"ra": integer, "label": string,
"model": string, "uuid": string,
"serial": string, "partlabel": string,
"state": string, "partuuid": string,
"owner": string, "ra": integer,
"group": string, "model": string,
"mode": string, "serial": string,
"alignment": integer, "state": string,
"min_io": integer, "owner": string,
"opt_io": integer, "group": string,
"phy_sec": integer, "mode": string,
"log_sec": integer, "alignment": integer,
"rota": boolean, "min_io": integer,
"sched": string, "opt_io": integer,
"rq_size": integer, "phy_sec": integer,
"disc_aln": integer, "log_sec": integer,
"disc_gran": string, "rota": boolean,
"disc_max": string, "sched": string,
"disc_zero": boolean, "rq_size": integer,
"wsame": string, "disc_aln": integer,
"wwn": string, "disc_gran": string,
"rand": boolean, "disc_gran_bytes": integer,
"pkname": string, "disc_max": string,
"hctl": string, "disc_max_bytes": integer,
"tran": string, "disc_zero": boolean,
"rev": string, "wsame": string,
"vendor": string "wsame_bytes": integer,
"wwn": string,
"rand": boolean,
"pkname": string,
"hctl": string,
"tran": string,
"rev": string,
"vendor": string
} }
] ]
@ -74,6 +81,7 @@ Examples:
"maj_min": "8:0", "maj_min": "8:0",
"rm": false, "rm": false,
"size": "20G", "size": "20G",
"size_bytes": 20000000000,
"ro": false, "ro": false,
"type": "disk", "type": "disk",
"mountpoint": null "mountpoint": null
@ -83,6 +91,7 @@ Examples:
"maj_min": "8:1", "maj_min": "8:1",
"rm": false, "rm": false,
"size": "1G", "size": "1G",
"size_bytes": 1000000000
"ro": false, "ro": false,
"type": "part", "type": "part",
"mountpoint": "/boot" "mountpoint": "/boot"
@ -100,6 +109,7 @@ Examples:
"maj_min": "8:0", "maj_min": "8:0",
"rm": false, "rm": false,
"size": "20G", "size": "20G",
"size_bytes": 20000000000,
"ro": false, "ro": false,
"type": "disk", "type": "disk",
"mountpoint": null, "mountpoint": null,
@ -126,9 +136,12 @@ Examples:
"rq_size": 128, "rq_size": 128,
"disc_aln": 0, "disc_aln": 0,
"disc_gran": "0B", "disc_gran": "0B",
"disc_gran_bytes": 0,
"disc_max": "0B", "disc_max": "0B",
"disc_max_bytes": 0,
"disc_zero": false, "disc_zero": false,
"wsame": "32M", "wsame": "32M",
"wsame_bytes": 32000000,
"wwn": null, "wwn": null,
"rand": true, "rand": true,
"pkname": null, "pkname": null,
@ -142,6 +155,7 @@ Examples:
"maj_min": "8:1", "maj_min": "8:1",
"rm": false, "rm": false,
"size": "1G", "size": "1G",
"size_bytes": 1000000000
"ro": false, "ro": false,
"type": "part", "type": "part",
"mountpoint": "/boot", "mountpoint": "/boot",
@ -168,9 +182,12 @@ Examples:
"rq_size": 128, "rq_size": 128,
"disc_aln": 0, "disc_aln": 0,
"disc_gran": "0B", "disc_gran": "0B",
"disc_gran_bytes": 0,
"disc_max": "0B", "disc_max": "0B",
"disc_max_bytes": 0,
"disc_zero": false, "disc_zero": false,
"wsame": "32M", "wsame": "32M",
"wsame_bytes": 32000000,
"wwn": null, "wwn": null,
"rand": true, "rand": true,
"pkname": "sda", "pkname": "sda",
@ -192,6 +209,7 @@ Examples:
"maj_min": "8:0", "maj_min": "8:0",
"rm": "0", "rm": "0",
"size": "20G", "size": "20G",
"size_bytes": 20000000000,
"ro": "0", "ro": "0",
"type": "disk", "type": "disk",
"mountpoint": null, "mountpoint": null,
@ -218,9 +236,12 @@ Examples:
"rq_size": "128", "rq_size": "128",
"disc_aln": "0", "disc_aln": "0",
"disc_gran": "0B", "disc_gran": "0B",
"disc_gran_bytes": 0,
"disc_max": "0B", "disc_max": "0B",
"disc_max_bytes": 0,
"disc_zero": "0", "disc_zero": "0",
"wsame": "32M", "wsame": "32M",
"wsame_bytes": 32000000,
"wwn": null, "wwn": null,
"rand": "1", "rand": "1",
"pkname": null, "pkname": null,
@ -234,6 +255,7 @@ Examples:
"maj_min": "8:1", "maj_min": "8:1",
"rm": "0", "rm": "0",
"size": "1G", "size": "1G",
"size_bytes": 1000000000
"ro": "0", "ro": "0",
"type": "part", "type": "part",
"mountpoint": "/boot", "mountpoint": "/boot",
@ -260,9 +282,12 @@ Examples:
"rq_size": "128", "rq_size": "128",
"disc_aln": "0", "disc_aln": "0",
"disc_gran": "0B", "disc_gran": "0B",
"disc_gran_bytes": 0,
"disc_max": "0B", "disc_max": "0B",
"disc_max_bytes": 0,
"disc_zero": "0", "disc_zero": "0",
"wsame": "32M", "wsame": "32M",
"wsame_bytes": 32000000,
"wwn": null, "wwn": null,
"rand": "1", "rand": "1",
"pkname": "sda", "pkname": "sda",
@ -299,4 +324,4 @@ Compatibility: linux
Source: [`jc/parsers/lsblk.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/lsblk.py) Source: [`jc/parsers/lsblk.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/lsblk.py)
Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/mount.md
View File

@ -100,4 +100,4 @@ Compatibility: linux, darwin, freebsd, aix
Source: [`jc/parsers/mount.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/mount.py) Source: [`jc/parsers/mount.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/mount.py)
Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

3
docs/parsers/nmcli.md
View File

@ -41,6 +41,7 @@ These are documented below.
[ [
{ {
"<key>": string/integer/float, # [0] "<key>": string/integer/float, # [0]
"team_config": object,
"dhcp4_option_x": { "dhcp4_option_x": {
"name": string, "name": string,
"value": string/integer/float, "value": string/integer/float,
@ -170,4 +171,4 @@ Compatibility: linux
Source: [`jc/parsers/nmcli.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/nmcli.py) Source: [`jc/parsers/nmcli.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/nmcli.py)
Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/time.md
View File

@ -157,4 +157,4 @@ Compatibility: linux, darwin, cygwin, aix, freebsd
Source: [`jc/parsers/time.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/time.py) Source: [`jc/parsers/time.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/time.py)
Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/x509_cert.md
View File

@ -435,4 +435,4 @@ Compatibility: linux, darwin, cygwin, win32, aix, freebsd
Source: [`jc/parsers/x509_cert.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/x509_cert.py) Source: [`jc/parsers/x509_cert.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/x509_cert.py)
Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

4
man/jc.1
View File

@ -1,4 +1,4 @@
.TH jc 1 2024-12-20 1.25.5 "JSON Convert" .TH jc 1 2025-05-10 1.25.5 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types,
and strings and strings
@ -1637,6 +1637,6 @@ Kelly Brazil (kellyjonbrazil@gmail.com)
https://github.com/kellyjonbrazil/jc https://github.com/kellyjonbrazil/jc
.SH COPYRIGHT .SH COPYRIGHT
Copyright (c) 2019-2024 Kelly Brazil Copyright (c) 2019-2025 Kelly Brazil
License: MIT License License: MIT License