diff --git a/docgen.sh b/docgen.sh index e07d0500..8d50855f 100755 --- a/docgen.sh +++ b/docgen.sh @@ -1,9 +1,6 @@ #!/bin/bash # Generate docs.md -# requires pydoc-markdown 2.1.0.post1 - -# old config -# '{"processors":[{"type":"filter"},{"type":"pydocmd"}]}' +# requires pydoc-markdown 4.5.0 cd jc echo Building docs for: package @@ -22,13 +19,13 @@ pydoc-markdown -m jc.parsers.universal '{"processors":[{"type":"filter","express # automate the generation of its own documentation. :) # pull jc parser objects into a bash array from jq +# filter out any plugin parsers parsers=() while read -r value do parsers+=("$value") done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)') -# iterate over the bash array for parser in "${parsers[@]}" do parser_name=$(jq -r '.name' <<< "$parser") @@ -40,7 +37,7 @@ do 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}" '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' >> ../docs/parsers/"${parser_name}".md - echo "## Parser Information" >> ../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 diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md index 05daa05b..92bf64f0 100644 --- a/docs/parsers/acpi.md +++ b/docs/parsers/acpi.md @@ -252,7 +252,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index c262f2b0..226d4eae 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -105,7 +105,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: darwin Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index 6eb7951e..9d0e5177 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -133,7 +133,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: darwin Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 385d74b5..1a7dd8d6 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -142,7 +142,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, aix, freebsd, darwin Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index 74ecda57..95abdc72 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -145,7 +145,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md index f5b3710b..042a43fb 100644 --- a/docs/parsers/cksum.md +++ b/docs/parsers/cksum.md @@ -79,7 +79,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index 1baf654d..9a4a9d2d 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -198,7 +198,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index 37e89575..08b10521 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -195,7 +195,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index 7aca68b0..09c39b8c 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -102,7 +102,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 10ac5910..047a2687 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -95,7 +95,7 @@ Returns: Iterator object -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/date.md b/docs/parsers/date.md index 48aad4f7..34169177 100644 --- a/docs/parsers/date.md +++ b/docs/parsers/date.md @@ -102,7 +102,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index 768b73a1..6f831f04 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -122,7 +122,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index d69a7a32..ef8df13f 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -347,7 +347,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, aix, freebsd, darwin, win32, cygwin Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md index 54e9a84a..1f3b2a88 100644 --- a/docs/parsers/dir.md +++ b/docs/parsers/dir.md @@ -145,7 +145,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: win32 Version 1.4 by Rasheed Elsaleh (rasheed@rebelliondefense.com) diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index edb3214e..19eefcfc 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -150,7 +150,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md index d88314d6..90748e70 100644 --- a/docs/parsers/dpkg_l.md +++ b/docs/parsers/dpkg_l.md @@ -156,7 +156,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/du.md b/docs/parsers/du.md index 681fa3bf..483f4e19 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -112,7 +112,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 56ef9a0e..c303226b 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -98,7 +98,7 @@ Returns: Dictionary of raw structured data or List of Dictionaries of processed structured data -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/file.md b/docs/parsers/file.md index c159c969..e9f9e4f5 100644 --- a/docs/parsers/file.md +++ b/docs/parsers/file.md @@ -87,7 +87,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, aix, freebsd, darwin Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/finger.md b/docs/parsers/finger.md index 3e23542e..9fe9a0b5 100644 --- a/docs/parsers/finger.md +++ b/docs/parsers/finger.md @@ -115,7 +115,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, freebsd Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/free.md b/docs/parsers/free.md index a0659f08..6969c514 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -97,7 +97,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/fstab.md b/docs/parsers/fstab.md index 42a3c826..ee5a7f56 100644 --- a/docs/parsers/fstab.md +++ b/docs/parsers/fstab.md @@ -110,7 +110,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/group.md b/docs/parsers/group.md index 6c6ebdf9..1efd774a 100644 --- a/docs/parsers/group.md +++ b/docs/parsers/group.md @@ -134,7 +134,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/gshadow.md b/docs/parsers/gshadow.md index ed4d675e..9fba86a0 100644 --- a/docs/parsers/gshadow.md +++ b/docs/parsers/gshadow.md @@ -102,7 +102,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, aix, freebsd Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hash.md b/docs/parsers/hash.md index e7120f09..31a31b24 100644 --- a/docs/parsers/hash.md +++ b/docs/parsers/hash.md @@ -62,7 +62,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hashsum.md b/docs/parsers/hashsum.md index ef6e597f..4440e05f 100644 --- a/docs/parsers/hashsum.md +++ b/docs/parsers/hashsum.md @@ -93,7 +93,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hciconfig.md b/docs/parsers/hciconfig.md index f787b1ac..036754c5 100644 --- a/docs/parsers/hciconfig.md +++ b/docs/parsers/hciconfig.md @@ -342,7 +342,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 7a27c543..73fc3f5d 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -89,7 +89,7 @@ Returns: Dictionary of raw structured data or List of Dictionaries of processed structured data -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hosts.md b/docs/parsers/hosts.md index 05baa2cb..683be7f9 100644 --- a/docs/parsers/hosts.md +++ b/docs/parsers/hosts.md @@ -99,7 +99,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/id.md b/docs/parsers/id.md index 40c7214f..e80cda8d 100644 --- a/docs/parsers/id.md +++ b/docs/parsers/id.md @@ -130,7 +130,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index 6419956e..351a7644 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -305,7 +305,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, aix, freebsd, darwin Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index 981f19df..7b6ac795 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -91,7 +91,7 @@ Returns: Dictionary representing the ini file -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iostat.md b/docs/parsers/iostat.md index ec41fca1..dd3e9b39 100644 --- a/docs/parsers/iostat.md +++ b/docs/parsers/iostat.md @@ -184,7 +184,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index 4fa918b7..f3e5e9d0 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -132,7 +132,7 @@ Returns: Iterator object -## Parser Information +#### Parser Information Compatibility: linux Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index b67aecda..bb63192b 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -188,7 +188,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iw_scan.md b/docs/parsers/iw_scan.md index fda6fc59..7a1b1dd9 100644 --- a/docs/parsers/iw_scan.md +++ b/docs/parsers/iw_scan.md @@ -146,7 +146,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 0.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/jar_manifest.md b/docs/parsers/jar_manifest.md index 89099f79..1e8f24dc 100644 --- a/docs/parsers/jar_manifest.md +++ b/docs/parsers/jar_manifest.md @@ -102,7 +102,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 0.01 by Matt J (https://github.com/listuser) diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index d7cdb6b9..3588989c 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -118,7 +118,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md index 8265f402..eb49bf6d 100644 --- a/docs/parsers/kv.md +++ b/docs/parsers/kv.md @@ -80,7 +80,7 @@ Returns: Dictionary representing the key/value file -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/last.md b/docs/parsers/last.md index 0f6a04e0..1b48a095 100644 --- a/docs/parsers/last.md +++ b/docs/parsers/last.md @@ -129,7 +129,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index 5de0f3ec..6d90ee38 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -141,7 +141,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 07b32395..cd5424ee 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -109,7 +109,7 @@ Returns: Iterator object -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 50958f35..d2e569b2 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -299,7 +299,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index 9d4183a4..1a3b87c8 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -150,7 +150,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 8fc90d71..51a2e165 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -144,7 +144,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsusb.md b/docs/parsers/lsusb.md index 23547f94..ed5e4822 100644 --- a/docs/parsers/lsusb.md +++ b/docs/parsers/lsusb.md @@ -286,7 +286,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index 6d0c01e1..b80c7009 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -100,7 +100,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index e2040fd3..78aff829 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -380,7 +380,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ntpq.md b/docs/parsers/ntpq.md index 145eed9f..dbe543b0 100644 --- a/docs/parsers/ntpq.md +++ b/docs/parsers/ntpq.md @@ -231,7 +231,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/passwd.md b/docs/parsers/passwd.md index 9b1d1401..c88f714c 100644 --- a/docs/parsers/passwd.md +++ b/docs/parsers/passwd.md @@ -119,7 +119,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ping.md b/docs/parsers/ping.md index 02026ef6..1b0f5ddb 100644 --- a/docs/parsers/ping.md +++ b/docs/parsers/ping.md @@ -187,7 +187,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index f8bb2aac..52e3785d 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -115,7 +115,7 @@ Returns: Iterator object -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/pip_list.md b/docs/parsers/pip_list.md index 622bac4b..eefb401e 100644 --- a/docs/parsers/pip_list.md +++ b/docs/parsers/pip_list.md @@ -72,7 +72,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/pip_show.md b/docs/parsers/pip_show.md index eb392c98..03c17fa7 100644 --- a/docs/parsers/pip_show.md +++ b/docs/parsers/pip_show.md @@ -90,7 +90,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index 676410c7..2869a74d 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -231,7 +231,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/route.md b/docs/parsers/route.md index 0c028027..8bb2fec2 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -133,7 +133,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/rpm_qi.md b/docs/parsers/rpm_qi.md index 814bc133..4dda0d92 100644 --- a/docs/parsers/rpm_qi.md +++ b/docs/parsers/rpm_qi.md @@ -186,7 +186,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/sfdisk.md b/docs/parsers/sfdisk.md index 09ded5f2..5e78e42f 100644 --- a/docs/parsers/sfdisk.md +++ b/docs/parsers/sfdisk.md @@ -227,7 +227,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md index 0e5e4acb..1e8a49f4 100644 --- a/docs/parsers/shadow.md +++ b/docs/parsers/shadow.md @@ -126,7 +126,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, aix, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 6f7878a4..13bd487f 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -305,7 +305,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/stat.md b/docs/parsers/stat.md index ca11d9fc..9d9b38bf 100644 --- a/docs/parsers/stat.md +++ b/docs/parsers/stat.md @@ -195,7 +195,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 7d4b1681..d21ece1f 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -113,7 +113,7 @@ Returns: Iterator object -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index a7a2f2f1..3981b995 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -82,7 +82,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl.md b/docs/parsers/systemctl.md index 4fdd0600..252402e2 100644 --- a/docs/parsers/systemctl.md +++ b/docs/parsers/systemctl.md @@ -83,7 +83,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl_lj.md b/docs/parsers/systemctl_lj.md index 07144bef..a80fcb70 100644 --- a/docs/parsers/systemctl_lj.md +++ b/docs/parsers/systemctl_lj.md @@ -100,7 +100,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl_ls.md b/docs/parsers/systemctl_ls.md index 10639596..d2af8c49 100644 --- a/docs/parsers/systemctl_ls.md +++ b/docs/parsers/systemctl_ls.md @@ -76,7 +76,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl_luf.md b/docs/parsers/systemctl_luf.md index ae77e85a..dd54e495 100644 --- a/docs/parsers/systemctl_luf.md +++ b/docs/parsers/systemctl_luf.md @@ -72,7 +72,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systeminfo.md b/docs/parsers/systeminfo.md index faee28bc..a9782080 100644 --- a/docs/parsers/systeminfo.md +++ b/docs/parsers/systeminfo.md @@ -236,7 +236,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: win32 Version 1.1 by Jon Smith (jon@rebelliondefense.com) diff --git a/docs/parsers/time.md b/docs/parsers/time.md index e331b755..b62c6331 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -157,7 +157,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/timedatectl.md b/docs/parsers/timedatectl.md index 14737d60..2249476b 100644 --- a/docs/parsers/timedatectl.md +++ b/docs/parsers/timedatectl.md @@ -89,7 +89,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/tracepath.md b/docs/parsers/tracepath.md index 560e2ef4..00d639b3 100644 --- a/docs/parsers/tracepath.md +++ b/docs/parsers/tracepath.md @@ -156,7 +156,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index 58142ebb..35a75ece 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -193,7 +193,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ufw.md b/docs/parsers/ufw.md index f18a4138..c450dc46 100644 --- a/docs/parsers/ufw.md +++ b/docs/parsers/ufw.md @@ -225,7 +225,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ufw_appinfo.md b/docs/parsers/ufw_appinfo.md index ee534199..95776cb4 100644 --- a/docs/parsers/ufw_appinfo.md +++ b/docs/parsers/ufw_appinfo.md @@ -163,7 +163,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 8f8a45c2..f40e2071 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -72,7 +72,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, freebsd Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/upower.md b/docs/parsers/upower.md index 46a9f219..34bace82 100644 --- a/docs/parsers/upower.md +++ b/docs/parsers/upower.md @@ -223,7 +223,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 054b6139..a5f86dbb 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -90,7 +90,7 @@ Returns: Dictionary. Raw or processed structured data -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/vmstat.md b/docs/parsers/vmstat.md index 0da217f5..a9d13d89 100644 --- a/docs/parsers/vmstat.md +++ b/docs/parsers/vmstat.md @@ -151,7 +151,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 7ddde404..ffa68a48 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -132,7 +132,7 @@ Returns: Iterator object -## Parser Information +#### Parser Information Compatibility: linux Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 1e7dfe3e..4ea57e51 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -128,7 +128,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/wc.md b/docs/parsers/wc.md index 4454a2d4..4967c19e 100644 --- a/docs/parsers/wc.md +++ b/docs/parsers/wc.md @@ -79,7 +79,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/who.md b/docs/parsers/who.md index 2dd0cce9..a3d90e43 100644 --- a/docs/parsers/who.md +++ b/docs/parsers/who.md @@ -160,7 +160,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index 2f473c66..5828a1f5 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -95,7 +95,7 @@ Returns: Dictionary. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index b9acb01e..1d6394aa 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -109,7 +109,7 @@ Returns: List of Dictionaries representing the YAML documents. -## Parser Information +#### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/zipinfo.md b/docs/parsers/zipinfo.md index cf655424..78436b75 100644 --- a/docs/parsers/zipinfo.md +++ b/docs/parsers/zipinfo.md @@ -104,7 +104,7 @@ Returns: List of Dictionaries. Raw or processed structured data. -## Parser Information +#### Parser Information Compatibility: linux, darwin Version 0.01 by Matt J (https://github.com/listuser)