python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-08-08 22:36:48 +02:00
Code Issues Releases Activity

formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-03-09 14:17:48 -08:00
parent bbd4afa735
commit c3198a5874
2 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
man/jc.1
View File

@ -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
<slow output>
.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).

17
templates/manpage_template
View File

@ -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
<slow output>
.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).