diff --git a/man/jc.1 b/man/jc.1 index c223da4d..04710341 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -600,7 +600,7 @@ Most operating systems will buffer output that is being piped from process to pr .RS .na .nf -$ ping 1.1.1.1 | jc --ping-s | jq +$ ping 1.1.1.1 | jc \fB--ping-s\fP | jq .fi .RE @@ -610,7 +610,7 @@ This is because the OS engages the 4KB buffer between \fBjc\fP and \fBjq\fP in t .RS .na .nf -$ ping 1.1.1.1 | jc --ping-s -u | jq +$ ping 1.1.1.1 | jc \fB--ping-s\fP \fB-u\fP | jq {"type":"reply","pattern":null,"timestamp":null,"bytes":"64",...} {"type":"reply","pattern":null,"timestamp":null,"bytes":"64",...} etc... @@ -623,11 +623,12 @@ Note: Unbuffered output can be slower for large data streams. Custom local parser plugins may be placed in a \fBjc/jcparsers\fP folder in your local "App data directory": .RS +.na +.nf - Linux/unix: \fB$HOME/.local/share/jc/jcparsers\fP - - macOS: \fB$HOME/Library/Application Support/jc/jcparsers\fP - - Windows: \fB$LOCALAPPDATA\\jc\\jc\\jcparsers\fP +.fi .RE Local parser plugins are standard python module files. Use the \fBjc/parsers/foo.py\fP parser as a template and simply place a \fB.py\fP file in the \fBjcparsers\fP subfolder. @@ -639,11 +640,15 @@ Note: The application data directory follows the XDG Base Directory Specificatio .SH CAVEATS \fBLocale:\fP For best results set the \fBLANG\fP locale environment variable to \fBC\fP or \fBen_US.UTF-8\fP. For example, either by setting directly on the command-line: -\fB$ LANG=C date | jc --date\fP +.RS +$ LANG=C date | jc \fB--date\fP +.RE or by exporting to the environment before running commands: -\fB$ export LANG=C\fP +.RS +$ export LANG=C +.RE \fBTimezones:\fP Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a \fB_utc\fP suffix it is considered naive. (i.e. based on the local timezone of the system the \fBjc\fP parser was run on). diff --git a/templates/manpage_template b/templates/manpage_template index fe1bc4fc..f37ccdbc 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -155,7 +155,7 @@ Most operating systems will buffer output that is being piped from process to pr .RS .na .nf -$ ping 1.1.1.1 | jc --ping-s | jq +$ ping 1.1.1.1 | jc \fB--ping-s\fP | jq .fi .RE @@ -165,7 +165,7 @@ This is because the OS engages the 4KB buffer between \fBjc\fP and \fBjq\fP in t .RS .na .nf -$ ping 1.1.1.1 | jc --ping-s -u | jq +$ ping 1.1.1.1 | jc \fB--ping-s\fP \fB-u\fP | jq {"type":"reply","pattern":null,"timestamp":null,"bytes":"64",...} {"type":"reply","pattern":null,"timestamp":null,"bytes":"64",...} etc... @@ -178,11 +178,12 @@ Note: Unbuffered output can be slower for large data streams. Custom local parser plugins may be placed in a \fBjc/jcparsers\fP folder in your local "App data directory": .RS +.na +.nf - Linux/unix: \fB$HOME/.local/share/jc/jcparsers\fP - - macOS: \fB$HOME/Library/Application Support/jc/jcparsers\fP - - Windows: \fB$LOCALAPPDATA\\jc\\jc\\jcparsers\fP +.fi .RE Local parser plugins are standard python module files. Use the \fBjc/parsers/foo.py\fP parser as a template and simply place a \fB.py\fP file in the \fBjcparsers\fP subfolder. @@ -194,11 +195,15 @@ Note: The application data directory follows the XDG Base Directory Specificatio .SH CAVEATS \fBLocale:\fP For best results set the \fBLANG\fP locale environment variable to \fBC\fP or \fBen_US.UTF-8\fP. For example, either by setting directly on the command-line: -\fB$ LANG=C date | jc --date\fP +.RS +$ LANG=C date | jc \fB--date\fP +.RE or by exporting to the environment before running commands: -\fB$ export LANG=C\fP +.RS +$ export LANG=C +.RE \fBTimezones:\fP Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a \fB_utc\fP suffix it is considered naive. (i.e. based on the local timezone of the system the \fBjc\fP parser was run on).