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

doc formatting change

This commit is contained in:
Kelly Brazil
2019-12-12 09:47:14 -08:00
parent 0ebb89f561
commit 9dca6ba539
55 changed files with 120 additions and 6 deletions

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility df Parser 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: Compatibility:
'linux', 'darwin' 'linux', 'darwin'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility dig Parser 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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility env Parser 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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility free Parser 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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility fstab Parser 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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility history Parser 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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility hosts Parser 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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -2,11 +2,13 @@
jc - JSON CLI output utility ifconfig Parser jc - JSON CLI output utility ifconfig Parser
Usage: Usage:
specify --ifconfig as the first argument if the piped input is coming from ifconfig specify --ifconfig as the first argument if the piped input is coming from ifconfig
no ifconfig options are supported. no ifconfig options are supported.
Compatibility: Compatibility:
'linux', 'aix', 'freebsd', 'darwin' 'linux', 'aix', 'freebsd', 'darwin'
Examples: Examples:

View File

@ -2,11 +2,13 @@
jc - JSON CLI output utility ipables Parser jc - JSON CLI output utility ipables Parser
Usage: Usage:
Specify --iptables as the first argument if the piped input is coming from iptables Specify --iptables as the first argument if the piped input is coming from iptables
Supports -vLn and --line-numbers for all tables Supports -vLn and --line-numbers for all tables
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,11 +2,13 @@
jc - JSON CLI output utility jobs Parser jc - JSON CLI output utility jobs Parser
Usage: Usage:
specify --jobs as the first argument if the piped input is coming from jobs specify --jobs as the first argument if the piped input is coming from jobs
Also supports the -l option Also supports the -l option
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Example: Example:

View File

@ -2,6 +2,7 @@
jc - JSON CLI output utility ls Parser jc - JSON CLI output utility ls Parser
Usage: Usage:
specify --ls as the first argument if the piped input is coming from ls specify --ls as the first argument if the piped input is coming from ls
ls options supported: ls options supported:
@ -12,6 +13,7 @@ Usage:
since the parser attempts to convert this field to an integer. since the parser attempts to convert this field to an integer.
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility lsblk Parser 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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility lsmod Parser 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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility lsof Parser 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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility mount Parser 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: Compatibility:
'linux' 'linux'
Example: Example:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility netstat Parser jc - JSON CLI output utility netstat Parser
Usage: Usage:
Specify --netstat as the first argument if the piped input is coming from netstat Specify --netstat as the first argument if the piped input is coming from netstat
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,6 +2,7 @@
jc - JSON CLI output utility ps Parser jc - JSON CLI output utility ps Parser
Usage: Usage:
specify --ps as the first argument if the piped input is coming from ps specify --ps as the first argument if the piped input is coming from ps
ps options supported: ps options supported:
@ -9,6 +10,7 @@ Usage:
- axu - axu
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility route Parser jc - JSON CLI output utility route Parser
Usage: Usage:
specify --route as the first argument if the piped input is coming from route specify --route as the first argument if the piped input is coming from route
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,12 +2,15 @@
jc - JSON CLI output utility ss Parser jc - JSON CLI output utility ss Parser
Usage: Usage:
specify --ss as the first argument if the piped input is coming from ss specify --ss as the first argument if the piped input is coming from ss
Limitations: Limitations:
Extended information options like -e and -p are not supported and may cause parsing irregularities Extended information options like -e and -p are not supported and may cause parsing irregularities
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility stats Parser jc - JSON CLI output utility stats Parser
Usage: Usage:
specify --stat as the first argument if the piped input is coming from stat specify --stat as the first argument if the piped input is coming from stat
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility systemctl Parser jc - JSON CLI output utility systemctl Parser
Usage: Usage:
specify --systemctl as the first argument if the piped input is coming from systemctl specify --systemctl as the first argument if the piped input is coming from systemctl
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility systemctl-lj Parser jc - JSON CLI output utility systemctl-lj Parser
Usage: Usage:
specify --systemctl-lj as the first argument if the piped input is coming from systemctl list-jobs specify --systemctl-lj as the first argument if the piped input is coming from systemctl list-jobs
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility systemctl-ls Parser jc - JSON CLI output utility systemctl-ls Parser
Usage: Usage:
specify --systemctl-ls as the first argument if the piped input is coming from systemctl list-sockets specify --systemctl-ls as the first argument if the piped input is coming from systemctl list-sockets
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility systemctl-luf Parser jc - JSON CLI output utility systemctl-luf Parser
Usage: Usage:
specify --systemctl-luf as the first argument if the piped input is coming from systemctl list-unit-files specify --systemctl-luf as the first argument if the piped input is coming from systemctl list-unit-files
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -2,12 +2,15 @@
jc - JSON CLI output utility uname Parser jc - JSON CLI output utility uname Parser
Usage: Usage:
specify --uname as the first argument if the piped input is coming from uname specify --uname as the first argument if the piped input is coming from uname
Limitations: Limitations:
must use 'uname -a' must use 'uname -a'
Compatibility: Compatibility:
'linux' 'linux'
Example: Example:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility uptime Parser jc - JSON CLI output utility uptime Parser
Usage: Usage:
specify --uptime as the first argument if the piped input is coming from uptime specify --uptime as the first argument if the piped input is coming from uptime
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Example: Example:

View File

@ -2,9 +2,11 @@
jc - JSON CLI output utility w Parser jc - JSON CLI output utility w Parser
Usage: Usage:
specify --w as the first argument if the piped input is coming from w specify --w as the first argument if the piped input is coming from w
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility df Parser """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: Compatibility:
'linux', 'darwin' 'linux', 'darwin'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility dig Parser """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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility env Parser """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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility foo Parser """jc - JSON CLI output utility foo Parser
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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility free Parser """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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility fstab Parser """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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility history Parser """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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility hosts Parser """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: Compatibility:
'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,11 +1,13 @@
"""jc - JSON CLI output utility ifconfig Parser """jc - JSON CLI output utility ifconfig Parser
Usage: Usage:
specify --ifconfig as the first argument if the piped input is coming from ifconfig specify --ifconfig as the first argument if the piped input is coming from ifconfig
no ifconfig options are supported. no ifconfig options are supported.
Compatibility: Compatibility:
'linux', 'aix', 'freebsd', 'darwin' 'linux', 'aix', 'freebsd', 'darwin'
Examples: Examples:

View File

@ -1,11 +1,13 @@
"""jc - JSON CLI output utility ipables Parser """jc - JSON CLI output utility ipables Parser
Usage: Usage:
Specify --iptables as the first argument if the piped input is coming from iptables Specify --iptables as the first argument if the piped input is coming from iptables
Supports -vLn and --line-numbers for all tables Supports -vLn and --line-numbers for all tables
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,11 +1,13 @@
"""jc - JSON CLI output utility jobs Parser """jc - JSON CLI output utility jobs Parser
Usage: Usage:
specify --jobs as the first argument if the piped input is coming from jobs specify --jobs as the first argument if the piped input is coming from jobs
Also supports the -l option Also supports the -l option
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Example: Example:

View File

@ -1,6 +1,7 @@
"""jc - JSON CLI output utility ls Parser """jc - JSON CLI output utility ls Parser
Usage: Usage:
specify --ls as the first argument if the piped input is coming from ls specify --ls as the first argument if the piped input is coming from ls
ls options supported: ls options supported:
@ -11,6 +12,7 @@ Usage:
since the parser attempts to convert this field to an integer. since the parser attempts to convert this field to an integer.
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility lsblk Parser """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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility lsmod Parser """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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility lsof Parser """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: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility mount Parser """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: Compatibility:
'linux' 'linux'
Example: Example:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility netstat Parser """jc - JSON CLI output utility netstat Parser
Usage: Usage:
Specify --netstat as the first argument if the piped input is coming from netstat Specify --netstat as the first argument if the piped input is coming from netstat
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,6 +1,7 @@
"""jc - JSON CLI output utility ps Parser """jc - JSON CLI output utility ps Parser
Usage: Usage:
specify --ps as the first argument if the piped input is coming from ps specify --ps as the first argument if the piped input is coming from ps
ps options supported: ps options supported:
@ -8,6 +9,7 @@ Usage:
- axu - axu
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility route Parser """jc - JSON CLI output utility route Parser
Usage: Usage:
specify --route as the first argument if the piped input is coming from route specify --route as the first argument if the piped input is coming from route
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,12 +1,15 @@
"""jc - JSON CLI output utility ss Parser """jc - JSON CLI output utility ss Parser
Usage: Usage:
specify --ss as the first argument if the piped input is coming from ss specify --ss as the first argument if the piped input is coming from ss
Limitations: Limitations:
Extended information options like -e and -p are not supported and may cause parsing irregularities Extended information options like -e and -p are not supported and may cause parsing irregularities
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility stats Parser """jc - JSON CLI output utility stats Parser
Usage: Usage:
specify --stat as the first argument if the piped input is coming from stat specify --stat as the first argument if the piped input is coming from stat
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility systemctl Parser """jc - JSON CLI output utility systemctl Parser
Usage: Usage:
specify --systemctl as the first argument if the piped input is coming from systemctl specify --systemctl as the first argument if the piped input is coming from systemctl
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility systemctl-lj Parser """jc - JSON CLI output utility systemctl-lj Parser
Usage: Usage:
specify --systemctl-lj as the first argument if the piped input is coming from systemctl list-jobs specify --systemctl-lj as the first argument if the piped input is coming from systemctl list-jobs
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility systemctl-ls Parser """jc - JSON CLI output utility systemctl-ls Parser
Usage: Usage:
specify --systemctl-ls as the first argument if the piped input is coming from systemctl list-sockets specify --systemctl-ls as the first argument if the piped input is coming from systemctl list-sockets
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility systemctl-luf Parser """jc - JSON CLI output utility systemctl-luf Parser
Usage: Usage:
specify --systemctl-luf as the first argument if the piped input is coming from systemctl list-unit-files specify --systemctl-luf as the first argument if the piped input is coming from systemctl list-unit-files
Compatibility: Compatibility:
'linux' 'linux'
Examples: Examples:

View File

@ -1,12 +1,15 @@
"""jc - JSON CLI output utility uname Parser """jc - JSON CLI output utility uname Parser
Usage: Usage:
specify --uname as the first argument if the piped input is coming from uname specify --uname as the first argument if the piped input is coming from uname
Limitations: Limitations:
must use 'uname -a' must use 'uname -a'
Compatibility: Compatibility:
'linux' 'linux'
Example: Example:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility uptime Parser """jc - JSON CLI output utility uptime Parser
Usage: Usage:
specify --uptime as the first argument if the piped input is coming from uptime specify --uptime as the first argument if the piped input is coming from uptime
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Example: Example:

View File

@ -1,9 +1,11 @@
"""jc - JSON CLI output utility w Parser """jc - JSON CLI output utility w Parser
Usage: Usage:
specify --w as the first argument if the piped input is coming from w specify --w as the first argument if the piped input is coming from w
Compatibility: Compatibility:
'linux', 'darwin', 'cygwin', 'aix', 'freebsd' 'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
Examples: Examples: