1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00

add compatibility to docs

This commit is contained in:
Kelly Brazil
2019-12-12 09:21:20 -08:00
parent ce134dc332
commit d615fa3b93
30 changed files with 91 additions and 1 deletions

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility arp Parser
Usage: Usage:
specify --arp as the first argument if the piped input is coming from arp specify --arp as the first argument if the piped input is coming from arp
Compatibility:
'linux', 'aix', 'freebsd', 'darwin'
Examples: Examples:
$ arp | jc --arp -p $ arp | jc --arp -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility df Parser
Usage: Usage:
specify --df as the first argument if the piped input is coming from df specify --df as the first argument if the piped input is coming from df
Compatibility:
'linux', 'darwin'
Examples: Examples:
$ df | jc --df -p $ df | jc --df -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility dig Parser
Usage: Usage:
Specify --dig as the first argument if the piped input is coming from dig Specify --dig as the first argument if the piped input is coming from dig
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility env Parser
Usage: Usage:
specify --env as the first argument if the piped input is coming from env specify --env as the first argument if the piped input is coming from env
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ env | jc --env -p $ env | jc --env -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility free Parser
Usage: Usage:
specify --free as the first argument if the piped input is coming from free specify --free as the first argument if the piped input is coming from free
Compatibility:
'linux'
Examples: Examples:
$ free | jc --free -p $ free | jc --free -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility fstab Parser
Usage: Usage:
specify --fstab as the first argument if the piped input is coming from a fstab file specify --fstab as the first argument if the piped input is coming from a fstab file
Compatibility:
'linux'
Examples: Examples:
$ cat /etc/fstab | jc --fstab -p $ cat /etc/fstab | jc --fstab -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility history Parser
Usage: Usage:
specify --history as the first argument if the piped input is coming from history specify --history as the first argument if the piped input is coming from history
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ history | jc --history -p $ history | jc --history -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility hosts Parser
Usage: Usage:
specify --hosts as the first argument if the piped input is coming from a hosts file specify --hosts as the first argument if the piped input is coming from a hosts file
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ cat /etc/hosts | jc --hosts -p $ cat /etc/hosts | jc --hosts -p

View File

@ -6,6 +6,9 @@ Usage:
no ifconfig options are supported. no ifconfig options are supported.
Compatibility:
'linux', 'aix', 'freebsd', 'darwin'
Examples: Examples:
$ ifconfig | jc --ifconfig -p $ ifconfig | jc --ifconfig -p

View File

@ -6,6 +6,9 @@ Usage:
Supports -vLn and --line-numbers for all tables Supports -vLn and --line-numbers for all tables
Compatibility:
'linux'
Examples: Examples:
$ sudo iptables --line-numbers -v -L -t nat | jc --iptables -p $ sudo iptables --line-numbers -v -L -t nat | jc --iptables -p

View File

@ -6,6 +6,9 @@ Usage:
Also supports the -l option Also supports the -l option
Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Example: Example:
$ jobs -l | jc --jobs -p $ jobs -l | jc --jobs -p

View File

@ -11,6 +11,9 @@ Usage:
with human readable suffixes will be converted to Null in default view with human readable suffixes will be converted to Null in default view
since the parser attempts to convert this field to an integer. since the parser attempts to convert this field to an integer.
Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:
$ ls /usr/bin | jc --ls -p $ ls /usr/bin | jc --ls -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility lsblk Parser
Usage: Usage:
specify --lsblk as the first argument if the piped input is coming from lsblk specify --lsblk as the first argument if the piped input is coming from lsblk
Compatibility:
'linux'
Examples: Examples:
$ lsblk | jc --lsblk -p $ lsblk | jc --lsblk -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility lsmod Parser
Usage: Usage:
specify --lsmod as the first argument if the piped input is coming from lsmod specify --lsmod as the first argument if the piped input is coming from lsmod
Compatibility:
'linux'
Examples: Examples:
$ lsmod | jc --lsmod -p $ lsmod | jc --lsmod -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility lsof Parser
Usage: Usage:
specify --lsof as the first argument if the piped input is coming from lsof specify --lsof as the first argument if the piped input is coming from lsof
Compatibility:
'linux'
Examples: Examples:
$ sudo lsof | jc --lsof -p $ sudo lsof | jc --lsof -p

View File

@ -4,6 +4,9 @@ jc - JSON CLI output utility mount Parser
Usage: Usage:
specify --mount as the first argument if the piped input is coming from mount specify --mount as the first argument if the piped input is coming from mount
Compatibility:
'linux'
Example: Example:
$ mount | jc --mount -p $ mount | jc --mount -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --env as the first argument if the piped input is coming from env specify --env as the first argument if the piped input is coming from env
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ env | jc --env -p $ env | jc --env -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --foo as the first argument if the piped input is coming from foo specify --foo as the first argument if the piped input is coming from foo
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ foo | jc --foo -p $ foo | jc --foo -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --free as the first argument if the piped input is coming from free specify --free as the first argument if the piped input is coming from free
Compatibility:
'linux'
Examples: Examples:
$ free | jc --free -p $ free | jc --free -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --fstab as the first argument if the piped input is coming from a fstab file specify --fstab as the first argument if the piped input is coming from a fstab file
Compatibility:
'linux'
Examples: Examples:
$ cat /etc/fstab | jc --fstab -p $ cat /etc/fstab | jc --fstab -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --history as the first argument if the piped input is coming from history specify --history as the first argument if the piped input is coming from history
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ history | jc --history -p $ history | jc --history -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --hosts as the first argument if the piped input is coming from a hosts file specify --hosts as the first argument if the piped input is coming from a hosts file
Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:
$ cat /etc/hosts | jc --hosts -p $ cat /etc/hosts | jc --hosts -p

View File

@ -5,6 +5,9 @@ Usage:
no ifconfig options are supported. no ifconfig options are supported.
Compatibility:
'linux', 'aix', 'freebsd', 'darwin'
Examples: Examples:
$ ifconfig | jc --ifconfig -p $ ifconfig | jc --ifconfig -p

View File

@ -5,6 +5,9 @@ Usage:
Supports -vLn and --line-numbers for all tables Supports -vLn and --line-numbers for all tables
Compatibility:
'linux'
Examples: Examples:
$ sudo iptables --line-numbers -v -L -t nat | jc --iptables -p $ sudo iptables --line-numbers -v -L -t nat | jc --iptables -p
@ -139,7 +142,7 @@ def process(proc_data):
Returns: Returns:
dictionary structured data with the following schema: dictionary structured data with the following schema:
[ [
{ {
"chain": string, "chain": string,

View File

@ -5,6 +5,9 @@ Usage:
Also supports the -l option Also supports the -l option
Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Example: Example:
$ jobs -l | jc --jobs -p $ jobs -l | jc --jobs -p

View File

@ -10,6 +10,9 @@ Usage:
with human readable suffixes will be converted to Null in default view with human readable suffixes will be converted to Null in default view
since the parser attempts to convert this field to an integer. since the parser attempts to convert this field to an integer.
Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:
$ ls /usr/bin | jc --ls -p $ ls /usr/bin | jc --ls -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --lsblk as the first argument if the piped input is coming from lsblk specify --lsblk as the first argument if the piped input is coming from lsblk
Compatibility:
'linux'
Examples: Examples:
$ lsblk | jc --lsblk -p $ lsblk | jc --lsblk -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --lsmod as the first argument if the piped input is coming from lsmod specify --lsmod as the first argument if the piped input is coming from lsmod
Compatibility:
'linux'
Examples: Examples:
$ lsmod | jc --lsmod -p $ lsmod | jc --lsmod -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --lsof as the first argument if the piped input is coming from lsof specify --lsof as the first argument if the piped input is coming from lsof
Compatibility:
'linux'
Examples: Examples:
$ sudo lsof | jc --lsof -p $ sudo lsof | jc --lsof -p

View File

@ -3,6 +3,9 @@
Usage: Usage:
specify --mount as the first argument if the piped input is coming from mount specify --mount as the first argument if the piped input is coming from mount
Compatibility:
'linux'
Example: Example:
$ mount | jc --mount -p $ mount | jc --mount -p