From 95aec9c6f9aa8fb4d0dae227410a1346d550f47f Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 18 May 2021 10:27:36 -0700 Subject: [PATCH] add info about Magic syntax not supporting shell builtins --- templates/manpage_template | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/templates/manpage_template b/templates/manpage_template index a1f7fb8c..ecdc814e 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -4,12 +4,12 @@ jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS COMMAND | jc PARSER [OPTIONS] -or magic syntax: +or "Magic" syntax: jc [OPTIONS] COMMAND .SH DESCRIPTION -jc JSONifies the output of many CLI tools and file-types for easier parsing in scripts. jc accepts piped input from \fBSTDIN\fP and outputs a JSON representation of the previous command's output to \fBSTDOUT\fP. Alternatively, the "magic" syntax can be used by prepending jc to the command to be converted. Options can be passed to jc immediately before the command is given. (Note: command aliases are not supported). +jc JSONifies the output of many CLI tools and file-types for easier parsing in scripts. jc accepts piped input from \fBSTDIN\fP and outputs a JSON representation of the previous command's output to \fBSTDOUT\fP. Alternatively, the "Magic" syntax can be used by prepending jc to the command to be converted. Options can be passed to jc immediately before the command is given. (Note: "Magic" syntax does not support shell builtins or command aliases) .SH OPTIONS .B @@ -63,7 +63,7 @@ raw JSON output version information .SH EXIT CODES -Any fatal errors within jc will generate an exit code of \fB100\fP, otherwise the exit code will be \fB0\fP. When using the "magic" syntax (e.g. \fBjc ifconfig eth0\fP), jc will store the exit code of the program being parsed and add it to the jc exit code. This way it is easier to determine if an error was from the parsed program or jc. +Any fatal errors within jc will generate an exit code of \fB100\fP, otherwise the exit code will be \fB0\fP. When using the "Magic" syntax (e.g. \fBjc ifconfig eth0\fP), jc will store the exit code of the program being parsed and add it to the jc exit code. This way it is easier to determine if an error was from the parsed program or jc. Consider the following examples using `ifconfig`: