From 13ffe8a84d27f8c630c590f8d6ce019d7e4153da Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 22 Jan 2023 12:44:16 -0800 Subject: [PATCH] doc update --- README.md | 4 ++-- completions/jc_zsh_completion.sh | 4 ++-- docs/parsers/ssh_conf.md | 2 +- docs/parsers/sshd_conf.md | 2 +- jc/parsers/ssh_conf.py | 4 ++-- jc/parsers/sshd_conf.py | 4 ++-- man/jc.1 | 4 ++-- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e8cf0ce6..8a643ea3 100644 --- a/README.md +++ b/README.md @@ -251,8 +251,8 @@ option. | ` --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) | -| ` --ssh-conf` | ssh config file and `ssh -G` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ssh_conf) | -| ` --sshd-conf` | sshd config file and `sshd -T` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/sshd_conf) | +| ` --ssh-conf` | `ssh` config file and `ssh -G` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ssh_conf) | +| ` --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) | diff --git a/completions/jc_zsh_completion.sh b/completions/jc_zsh_completion.sh index c718ddd2..8823e30e 100644 --- a/completions/jc_zsh_completion.sh +++ b/completions/jc_zsh_completion.sh @@ -251,8 +251,8 @@ _jc() { '--sfdisk:`sfdisk` command parser' '--shadow:`/etc/shadow` file parser' '--ss:`ss` command parser' - '--ssh-conf:ssh config file and `ssh -G` command parser' - '--sshd-conf:sshd config file and `sshd -T` command parser' + '--ssh-conf:`ssh` config file and `ssh -G` 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' diff --git a/docs/parsers/ssh_conf.md b/docs/parsers/ssh_conf.md index 077db643..77acfeaa 100644 --- a/docs/parsers/ssh_conf.md +++ b/docs/parsers/ssh_conf.md @@ -3,7 +3,7 @@ # jc.parsers.ssh\_conf -jc - JSON Convert ssh configuration file and `ssh -G` command output parser +jc - JSON Convert `ssh` configuration file and `ssh -G` command output parser This parser will work with `ssh` configuration files or the output of `ssh -G`. Any `Match` blocks in the `ssh` configuration file will be diff --git a/docs/parsers/sshd_conf.md b/docs/parsers/sshd_conf.md index 2926b684..bffeb82f 100644 --- a/docs/parsers/sshd_conf.md +++ b/docs/parsers/sshd_conf.md @@ -3,7 +3,7 @@ # jc.parsers.sshd\_conf -jc - JSON Convert sshd configuration file and `sshd -T` command output parser +jc - JSON Convert `sshd` configuration file and `sshd -T` command output parser This parser will work with `sshd` configuration files or the output of `sshd -T`. Any `Match` blocks in the `sshd` configuration file will be diff --git a/jc/parsers/ssh_conf.py b/jc/parsers/ssh_conf.py index 1e9883f5..45ed2cdd 100644 --- a/jc/parsers/ssh_conf.py +++ b/jc/parsers/ssh_conf.py @@ -1,4 +1,4 @@ -"""jc - JSON Convert ssh configuration file and `ssh -G` command output parser +"""jc - JSON Convert `ssh` configuration file and `ssh -G` command output parser This parser will work with `ssh` configuration files or the output of `ssh -G`. Any `Match` blocks in the `ssh` configuration file will be @@ -482,7 +482,7 @@ import jc.utils class info(): """Provides parser metadata (version, author, etc.)""" version = '1.0' - description = 'ssh config file and `ssh -G` command parser' + description = '`ssh` config file and `ssh -G` command parser' author = 'Kelly Brazil' author_email = 'kellyjonbrazil@gmail.com' compatible = ['linux', 'darwin', 'freebsd'] diff --git a/jc/parsers/sshd_conf.py b/jc/parsers/sshd_conf.py index 62782ade..a295e237 100644 --- a/jc/parsers/sshd_conf.py +++ b/jc/parsers/sshd_conf.py @@ -1,4 +1,4 @@ -"""jc - JSON Convert sshd configuration file and `sshd -T` command output parser +"""jc - JSON Convert `sshd` configuration file and `sshd -T` command output parser This parser will work with `sshd` configuration files or the output of `sshd -T`. Any `Match` blocks in the `sshd` configuration file will be @@ -484,7 +484,7 @@ import jc.utils class info(): """Provides parser metadata (version, author, etc.)""" version = '1.1' - description = 'sshd config file and `sshd -T` command parser' + description = '`sshd` config file and `sshd -T` command parser' author = 'Kelly Brazil' author_email = 'kellyjonbrazil@gmail.com' compatible = ['linux', 'darwin', 'freebsd'] diff --git a/man/jc.1 b/man/jc.1 index af9d0613..a0a4c126 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -768,12 +768,12 @@ Semantic Version string parser .TP .B \fB--ssh-conf\fP -ssh config file and `ssh -G` command parser +`ssh` config file and `ssh -G` command parser .TP .B \fB--sshd-conf\fP -sshd config file and `sshd -T` command parser +`sshd` config file and `sshd -T` command parser .TP .B