From 8d8c58742e5106c3387a627cd1b1323a76cc9623 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 11 May 2021 11:32:08 -0700 Subject: [PATCH] formatting --- README.md | 13 ++++++++----- jc/man/jc.1.gz | Bin 2663 -> 2663 bytes man/jc.1.gz | Bin 2663 -> 2663 bytes templates/manpage_template | 10 +++++----- templates/readme_template | 13 ++++++++----- 5 files changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c717584f..517971b2 100644 --- a/README.md +++ b/README.md @@ -204,13 +204,16 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio - `-v` version information ### Exit Codes -Any fatal errors within `jc` will generate an exit code of `100`, otherwise the exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`), `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 tell if an error was from the parsed program or `jc`. +Any fatal errors within `jc` will generate an exit code of `100`, otherwise the exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`), `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`: -- `ifconfig` exit code = `0`, `jc` exit code = `0`, combined exit code = `0` (no errors) -- `ifconfig` exit code = `1`, `jc` exit code = `0`, combined exit code = `1` (error in `ifconfig`) -- `ifconfig` exit code = `0`, `jc` exit code = `100`, combined exit code = `100` (error in `jc`) -- `ifconfig` exit code = `1`, `jc` exit code = `100`, combined exit code = `101` (error in both `ifconfig` and `jc`) +| `ifconfig` exit code | `jc` exit code | Combined exit code | Interpretation | +|----------------------|----------------|--------------------|------------------------------------| +| `0` | `0` | `0` | No errors | +| `1` | `0` | `1` | Error in `ifconfig` | +| `0` | `100` | `100` | Error in `jc` | +| `1` | `100` | `101` | Error in both `ifconfig` and `jc` | + ### Setting Custom Colors via Environment Variable You can specify custom colors via the `JC_COLORS` environment variable. The `JC_COLORS` environment variable takes four comma separated string values in the following format: diff --git a/jc/man/jc.1.gz b/jc/man/jc.1.gz index ec57ac5680aab1ad75fbc247478f8e33668a66ca..413e8b30bd3bd06beaf40e60f046af5b4a325ead 100644 GIT binary patch delta 2625 zcmV-H3cmH{6z3FwABzYG^~;)I0{?1bE-?U|S#59II1>KuUqJ*5TnfZ;Qd}3f;CeXM z$!@co*g@=eTeL+(OSH{I5>=9lqs9IBn-@x!jl>H2A@NXp=7po-aE6R#@5Nm#PQ>fu z*C+ksH~o_naT1-piT)`L{+Le2Vsv>SOzDf#i_+^<`|6;77fs)b@$l-r2b^E~0&#kw zl@orYYOq;|Oy(8wdt*{3WS)qHPF3Gmg>och`guILo?c9Qqsi6PaC|2IhsInFZ>Hxr z;>+ZEb}<=Gzx8^?g0Q8Ig{yKeA5VLzxp^-FcaLPAoli$M7xW5IKV_U)fJP;qR#p_! zI-M_t&V`F0tuDNa&`24_3TRR2LM8AL#V)ML#Mi~U>Fn%c{B?0nlO6#j739MVL`Gtm zdS!Fqeo$$3MBE4DoP(2C0V97V1={6mA%%1(24KLevrHvgdQc4Sz(;CJmUdzZR^^d6 z92>7rn-?d+>I4jZeV^{l1I~ z4KC>2B5~VDFNk9Ysx4|@G}EGg@gknS+vai|T()4mE%pQF>Ag+}O4NUTaD4B|jKDBr}_BoI5K0Ezum zNfr!TbinkIaeCPWv;k;4fSFEIY?5GTJ?da8?w9?PIe--Xv;)t6PRji-m6K0z;deg} zJx)j@x}f<|*#Jhe18#p+kPJiz)YY*!P(B{e@b>v&SXxsS8#oR3!QDzGX5C`o2YXmn z(ya)O#D3cm5tdvaci`giHcQ^%3Os^^2pFQkj_B2nq*y~bU4*!7Mjh(4^Tt-p!gL3N zao%lwLBltsUO*(IitVij9b$jieFs|*bF4+89>f>; zr(^X^;EVm-cV^DYkk}8srxo_6ss z$&BDggztmouN{ASbkR?B__Qz(IOt|^tB{J21qU5090f&36hI0L8zfO3;3Dh);DQK9 z0rYaG>*Nhx#fY2SX4Ae}EvO9~G6vw59yBn?Vu2XlX&5AaDh4_0Qi$6I58AGho< z)msTok@URjHlwf@oAIwNkg{0`n_*iHJ?IcrE;!oZ_eJIdt}lzCaW(S6Sl|Qk1*lZV z)U|!cd!j^NcHj%M4iy=bUGV1HGPxhlKIq6#>zGk-2W-Wjf#3bW$BZKA)79nk z>7|kk`aFN!MM3X(-ixjY8v4=D54QLv^2#~H0k)=x)Le7V{HhJ3EhJI%5{hz4)Pmw? zF5`P~NB~4o!w)U++&HxXYzd;EUa7QTww1s=3hn(KJ~zn-#bRROGOL^XEiqJLW+pfB z%9^Y`k!T~RCWfZnd+gnH?w`QWM*5@F%Hyn{9kYMRIkA>DhaJzgkrY=}u0_j1?e|pv zz|0+%)+FpS))bjQDy~f4Z#PS zTKu#}3t=9OJKAK!kZlM%V*3KMv=z9f+I{AnF<=Z~uL-DolCb$>#qY;dpIq(v0&mn?qWx zhpZtCdp%g%R@L*BR-NJ$<|(9G@;MBwN@{XxmCEZurO>K+GzWug8qxzM+jG*UKyQD+AnfRw-%a3-K1^qmt8gGc?Tt8A zQxn535O%sEEtfiXB9j%J7lU>>4;PXX^x!ULq~k3z#bgJsD-1@KbTEV>3+jJNDH3g= z*fh2}2s7-9OP!aG11OdsDNufSKe;*|M8t?4j8%gj9X(*mWIUO+@RxdSrL6|TO${fe ze2DoJ`(HYT&d9NV%gJbXIlR6;8_tGbzuv|5UyFtOb@`N6@WdNR&peS9a)0Glpcp## zGUbB?7l{vHGh}B4p@W4nQGtJPTMLwUfdGX+_?Na=ShyMn6+4`r9XP0z3JaN}w*2qP zIe&tvF_kwAmxPRvez`^$en_!cbX|a-!2$a<^ z->!fgtmi{yDN?9zzzET{fn&%(En;CuY$86q1cUif0h3;<7T*b+kh*{Pw&&B?@8X>V z2cI>sr<8UBZwT_?$MfNAiq#OAqfXINxEALMW(AcMnBjOavP&uV~*IxLO+IzD-P9?LbQH> zE$~oB@P96`whHd!q~e41b;ZYh^JY=B))v-j;2Ge@`=|>DUh#inHrhxCS7BJ>#h#NJ zit*~v*V5}=h$qRna+~?p{>-9QX8nc9Y118C_*SdKTO~*n> z@QQ9}x1|II1U-Erk@%iw?=q7*MU_wyuDmbY>0q#g#aPbq;b0pLdqT(#lk3kn7r(!sL8)F;w8M(S_?38l jeDbe8UYd)xQpl=0R=I;bC9a@#3Zwr6jI#|YW*-0mFZB>% delta 2625 zcmV-H3cmH{6z3FwABzYGipZK^0{?1bE-?U|S#59II1>KuUqJ*5TnfZ;Qd}3<;CeXM z$!@)y*g@=eTeL+@OSH{I5>=9lqs9IBn-|KKjl{~{hr~nanHP?R!x=J~z880~I1{f= zU!QeP-*nH;#94IqCi)e7p2#!_SI2;Cz`w$qyF_}2ROfW1>*EV zD<}L))nKy_nanHV_r|17$UG4XovN;{3gt-1=Ki^kmaZzq?x z;>-AEIvkHC-#Q&*LD*8q!d1DKkLMlKym>DIcZXzNTuuhJLwbd%|I0YB0F6pIt*j`d zbvj=PoeLKrTU~e;p^-9<70{y4g-YNhid|TfiLZ-ylj+59^mTDVlO6#j75KvxL`I^Y zdS!Fqeo$$3Lfl8>oTHOi0V99L1={6mA%%1(24KLevrHvgdQc4Sz(;CFmUdzZR^^d6 z9vQFBH!ozWr30@@V91RZt}F_J>Rv_s&BB-LMDIE`;BIBzc_+G^bl~mu2A_fpx?LF; z8eGtsAu-!XFNk9gsx4|@G}EFxd=XFA?Q*#mE?Y3(7KefJ^j;?fCF*}LIKFpfMqr|5 z6iG9p4zgJT5in;)rnd}rh#%tYmb<(SyjW|$!l1JC_uG@;9*}o1`S`q+1Y(C2AaQsq z$%2847MNZ#PA}VlHUMo4Fw=>OO%e>PM=ean{j!@f2auwhw&2;%NqHEia`Nd6eh&lD zMX=XU_-2(wef^!fAL2?p87}>jncqIKZ-! zZbf(`4%?21u;c={2N%b)EO~<~@B|hjV2A=cqE~y8Vh!nZ5#n+)YEiG9H@0FHrdt?{ z^KR=48XoXO$UJRnM=u(t*Mk<8oO1GTG(4cafJjIc+glG>#IAq44z?iXSc^nGh%fL@ z$LgEF7l*m;%$$`WaTt0}E9?(d^*+k9RL@T$m5%olBtk+)a(-BT%7&z_4F9X93AgBC&Mf}3w$8H0F~;P zy0&jEa&j4bPn77&7JOmWp(10l4ZiudOdf`_4_flmI%ZVd0$Z_X;P)`_F{23jbba-F zdZ{FXKKFn3QPBHccA^`ChJG~kgAIO(ymAh4fUW5vS1K)-Z6$DzLVLf5&rLEyv6z^+%<3k8M+}vinaNGO zvL>rfB$^1SiJ@ut9(#A4`zJ88k^U&P@;EDK$E<&HPOPQPVaIb#B*m4LYte8}^F5V6 zFms2e5g6$ZD-@me2b-Hs>s6X=Mi5Pyu}`Zj5D;2<_|B5t6lGj>Hsda`0}25TL@z z5P}ux(+iq0dIdm^kAX-V%deHfYZM%HIs=Gk=qoLu7A8&28tqY!GAm$12=m`o;O89* z|3*o^o!MLT+sU5E^;1}*kov)fy*J`GH{pLfLi_TZ+_S$a_YCB+8!#?5LJw$o+Hww; zXLOvN?q~t#zdeJ)@^@x2hoEgtg?Av*i8+eb$mrwnc09Vi98Ei)O-Uzbu28XFR3a`R z7_pU1am74nNnae+-S30%gYnh)c7llm+IwwHjtN6NNUO0w!k~K@Qh0e!N0z1KoGgDF zY_qr!6IcosBk2KK8;A4R4LDxy5M3K3Z~t|#DokkK$>x8b;CO9pvKi-PHix8F4_QMP zb~>gCGs=;B8Wjr?FoFF)GT9z<_8Zvrg%Ev)wKH$g*A8q+%ocAU^e@OZrW1%t4YXMVSVJNPh}j<3UU`=m4ASWQg~ zIX>)TMOrR(?nEXlIt>QxblNQ>&h9Sm-NlS_yaA?|)Zlf6!N`)1`cOha6)As3qAiq? z##TpRhFx)`^YXC=rSKyK%1`gd*O$GB7_mRGs<)@315BBW$CC#BO3$sdRj?5rTPw=gCuFm8WqffBC=psWY~()I}pSHqxUhqJQ-2NgqNwGNr1&e2o27Uv3P1$7gc;dn8!ORxH)-w;DlsGdo=bSpEU z3z?mDtu(q1uU$Z*#~jPXqu=u8ZAmwUy$99-2BAQeZwEM8#aCe4qjJ3a0%__I!36`QElEg|rfSEFl%ak?|RY0*S zu+xCAoD~pFDoq@gOnfu6y;y^Q&r_^KTUe2SXMi7Xn}!g);=_M*u$2%lx)OzbE+;n> z9XO)_#g)IQd*#Z4Zj0{)J8{r}8 z)E8*fbFjXRK`yFm_x|&w?J4HopCB-oV!d8ROJkN$Z@?ru_8RvpV$+XM z61=86*j*`s0YQCFNMycWpJ|NtWUOk9^{o!IfiRQ)hw1zAZRZczqbu>w%D;3fj_+}F zXYx6X|Fg`bPEjRPgDdX~ci!tQVKJ6-eAwGX!=4bb!}#X&?eMqvQz*%cigs9W9KRB; jPtSho;+42)Dut}7W0gC|Q{oyLqcHj(fU_SUL>~YE)R+71 diff --git a/man/jc.1.gz b/man/jc.1.gz index ec57ac5680aab1ad75fbc247478f8e33668a66ca..413e8b30bd3bd06beaf40e60f046af5b4a325ead 100644 GIT binary patch delta 2625 zcmV-H3cmH{6z3FwABzYG^~;)I0{?1bE-?U|S#59II1>KuUqJ*5TnfZ;Qd}3f;CeXM z$!@co*g@=eTeL+(OSH{I5>=9lqs9IBn-@x!jl>H2A@NXp=7po-aE6R#@5Nm#PQ>fu z*C+ksH~o_naT1-piT)`L{+Le2Vsv>SOzDf#i_+^<`|6;77fs)b@$l-r2b^E~0&#kw zl@orYYOq;|Oy(8wdt*{3WS)qHPF3Gmg>och`guILo?c9Qqsi6PaC|2IhsInFZ>Hxr z;>+ZEb}<=Gzx8^?g0Q8Ig{yKeA5VLzxp^-FcaLPAoli$M7xW5IKV_U)fJP;qR#p_! zI-M_t&V`F0tuDNa&`24_3TRR2LM8AL#V)ML#Mi~U>Fn%c{B?0nlO6#j739MVL`Gtm zdS!Fqeo$$3MBE4DoP(2C0V97V1={6mA%%1(24KLevrHvgdQc4Sz(;CJmUdzZR^^d6 z92>7rn-?d+>I4jZeV^{l1I~ z4KC>2B5~VDFNk9Ysx4|@G}EGg@gknS+vai|T()4mE%pQF>Ag+}O4NUTaD4B|jKDBr}_BoI5K0Ezum zNfr!TbinkIaeCPWv;k;4fSFEIY?5GTJ?da8?w9?PIe--Xv;)t6PRji-m6K0z;deg} zJx)j@x}f<|*#Jhe18#p+kPJiz)YY*!P(B{e@b>v&SXxsS8#oR3!QDzGX5C`o2YXmn z(ya)O#D3cm5tdvaci`giHcQ^%3Os^^2pFQkj_B2nq*y~bU4*!7Mjh(4^Tt-p!gL3N zao%lwLBltsUO*(IitVij9b$jieFs|*bF4+89>f>; zr(^X^;EVm-cV^DYkk}8srxo_6ss z$&BDggztmouN{ASbkR?B__Qz(IOt|^tB{J21qU5090f&36hI0L8zfO3;3Dh);DQK9 z0rYaG>*Nhx#fY2SX4Ae}EvO9~G6vw59yBn?Vu2XlX&5AaDh4_0Qi$6I58AGho< z)msTok@URjHlwf@oAIwNkg{0`n_*iHJ?IcrE;!oZ_eJIdt}lzCaW(S6Sl|Qk1*lZV z)U|!cd!j^NcHj%M4iy=bUGV1HGPxhlKIq6#>zGk-2W-Wjf#3bW$BZKA)79nk z>7|kk`aFN!MM3X(-ixjY8v4=D54QLv^2#~H0k)=x)Le7V{HhJ3EhJI%5{hz4)Pmw? zF5`P~NB~4o!w)U++&HxXYzd;EUa7QTww1s=3hn(KJ~zn-#bRROGOL^XEiqJLW+pfB z%9^Y`k!T~RCWfZnd+gnH?w`QWM*5@F%Hyn{9kYMRIkA>DhaJzgkrY=}u0_j1?e|pv zz|0+%)+FpS))bjQDy~f4Z#PS zTKu#}3t=9OJKAK!kZlM%V*3KMv=z9f+I{AnF<=Z~uL-DolCb$>#qY;dpIq(v0&mn?qWx zhpZtCdp%g%R@L*BR-NJ$<|(9G@;MBwN@{XxmCEZurO>K+GzWug8qxzM+jG*UKyQD+AnfRw-%a3-K1^qmt8gGc?Tt8A zQxn535O%sEEtfiXB9j%J7lU>>4;PXX^x!ULq~k3z#bgJsD-1@KbTEV>3+jJNDH3g= z*fh2}2s7-9OP!aG11OdsDNufSKe;*|M8t?4j8%gj9X(*mWIUO+@RxdSrL6|TO${fe ze2DoJ`(HYT&d9NV%gJbXIlR6;8_tGbzuv|5UyFtOb@`N6@WdNR&peS9a)0Glpcp## zGUbB?7l{vHGh}B4p@W4nQGtJPTMLwUfdGX+_?Na=ShyMn6+4`r9XP0z3JaN}w*2qP zIe&tvF_kwAmxPRvez`^$en_!cbX|a-!2$a<^ z->!fgtmi{yDN?9zzzET{fn&%(En;CuY$86q1cUif0h3;<7T*b+kh*{Pw&&B?@8X>V z2cI>sr<8UBZwT_?$MfNAiq#OAqfXINxEALMW(AcMnBjOavP&uV~*IxLO+IzD-P9?LbQH> zE$~oB@P96`whHd!q~e41b;ZYh^JY=B))v-j;2Ge@`=|>DUh#inHrhxCS7BJ>#h#NJ zit*~v*V5}=h$qRna+~?p{>-9QX8nc9Y118C_*SdKTO~*n> z@QQ9}x1|II1U-Erk@%iw?=q7*MU_wyuDmbY>0q#g#aPbq;b0pLdqT(#lk3kn7r(!sL8)F;w8M(S_?38l jeDbe8UYd)xQpl=0R=I;bC9a@#3Zwr6jI#|YW*-0mFZB>% delta 2625 zcmV-H3cmH{6z3FwABzYGipZK^0{?1bE-?U|S#59II1>KuUqJ*5TnfZ;Qd}3<;CeXM z$!@)y*g@=eTeL+@OSH{I5>=9lqs9IBn-|KKjl{~{hr~nanHP?R!x=J~z880~I1{f= zU!QeP-*nH;#94IqCi)e7p2#!_SI2;Cz`w$qyF_}2ROfW1>*EV zD<}L))nKy_nanHV_r|17$UG4XovN;{3gt-1=Ki^kmaZzq?x z;>-AEIvkHC-#Q&*LD*8q!d1DKkLMlKym>DIcZXzNTuuhJLwbd%|I0YB0F6pIt*j`d zbvj=PoeLKrTU~e;p^-9<70{y4g-YNhid|TfiLZ-ylj+59^mTDVlO6#j75KvxL`I^Y zdS!Fqeo$$3Lfl8>oTHOi0V99L1={6mA%%1(24KLevrHvgdQc4Sz(;CFmUdzZR^^d6 z9vQFBH!ozWr30@@V91RZt}F_J>Rv_s&BB-LMDIE`;BIBzc_+G^bl~mu2A_fpx?LF; z8eGtsAu-!XFNk9gsx4|@G}EFxd=XFA?Q*#mE?Y3(7KefJ^j;?fCF*}LIKFpfMqr|5 z6iG9p4zgJT5in;)rnd}rh#%tYmb<(SyjW|$!l1JC_uG@;9*}o1`S`q+1Y(C2AaQsq z$%2847MNZ#PA}VlHUMo4Fw=>OO%e>PM=ean{j!@f2auwhw&2;%NqHEia`Nd6eh&lD zMX=XU_-2(wef^!fAL2?p87}>jncqIKZ-! zZbf(`4%?21u;c={2N%b)EO~<~@B|hjV2A=cqE~y8Vh!nZ5#n+)YEiG9H@0FHrdt?{ z^KR=48XoXO$UJRnM=u(t*Mk<8oO1GTG(4cafJjIc+glG>#IAq44z?iXSc^nGh%fL@ z$LgEF7l*m;%$$`WaTt0}E9?(d^*+k9RL@T$m5%olBtk+)a(-BT%7&z_4F9X93AgBC&Mf}3w$8H0F~;P zy0&jEa&j4bPn77&7JOmWp(10l4ZiudOdf`_4_flmI%ZVd0$Z_X;P)`_F{23jbba-F zdZ{FXKKFn3QPBHccA^`ChJG~kgAIO(ymAh4fUW5vS1K)-Z6$DzLVLf5&rLEyv6z^+%<3k8M+}vinaNGO zvL>rfB$^1SiJ@ut9(#A4`zJ88k^U&P@;EDK$E<&HPOPQPVaIb#B*m4LYte8}^F5V6 zFms2e5g6$ZD-@me2b-Hs>s6X=Mi5Pyu}`Zj5D;2<_|B5t6lGj>Hsda`0}25TL@z z5P}ux(+iq0dIdm^kAX-V%deHfYZM%HIs=Gk=qoLu7A8&28tqY!GAm$12=m`o;O89* z|3*o^o!MLT+sU5E^;1}*kov)fy*J`GH{pLfLi_TZ+_S$a_YCB+8!#?5LJw$o+Hww; zXLOvN?q~t#zdeJ)@^@x2hoEgtg?Av*i8+eb$mrwnc09Vi98Ei)O-Uzbu28XFR3a`R z7_pU1am74nNnae+-S30%gYnh)c7llm+IwwHjtN6NNUO0w!k~K@Qh0e!N0z1KoGgDF zY_qr!6IcosBk2KK8;A4R4LDxy5M3K3Z~t|#DokkK$>x8b;CO9pvKi-PHix8F4_QMP zb~>gCGs=;B8Wjr?FoFF)GT9z<_8Zvrg%Ev)wKH$g*A8q+%ocAU^e@OZrW1%t4YXMVSVJNPh}j<3UU`=m4ASWQg~ zIX>)TMOrR(?nEXlIt>QxblNQ>&h9Sm-NlS_yaA?|)Zlf6!N`)1`cOha6)As3qAiq? z##TpRhFx)`^YXC=rSKyK%1`gd*O$GB7_mRGs<)@315BBW$CC#BO3$sdRj?5rTPw=gCuFm8WqffBC=psWY~()I}pSHqxUhqJQ-2NgqNwGNr1&e2o27Uv3P1$7gc;dn8!ORxH)-w;DlsGdo=bSpEU z3z?mDtu(q1uU$Z*#~jPXqu=u8ZAmwUy$99-2BAQeZwEM8#aCe4qjJ3a0%__I!36`QElEg|rfSEFl%ak?|RY0*S zu+xCAoD~pFDoq@gOnfu6y;y^Q&r_^KTUe2SXMi7Xn}!g);=_M*u$2%lx)OzbE+;n> z9XO)_#g)IQd*#Z4Zj0{)J8{r}8 z)E8*fbFjXRK`yFm_x|&w?J4HopCB-oV!d8ROJkN$Z@?ru_8RvpV$+XM z61=86*j*`s0YQCFNMycWpJ|NtWUOk9^{o!IfiRQ)hw1zAZRZczqbu>w%D;3fj_+}F zXYx6X|Fg`bPEjRPgDdX~ci!tQVKJ6-eAwGX!=4bb!}#X&?eMqvQz*%cigs9W9KRB; jPtSho;+42)Dut}7W0gC|Q{oyLqcHj(fU_SUL>~YE)R+71 diff --git a/templates/manpage_template b/templates/manpage_template index 49eee6ae..a1f7fb8c 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -63,18 +63,18 @@ raw JSON output version information .SH EXIT CODES -Any fatal errors within `jc` will generate an exit code of `100`, otherwise the exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`), `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 tell 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`: .RS -`ifconfig` exit code = `0`, `jc` exit code = `0`, combined exit code = `0` (no errors) +ifconfig exit code = \fB0\fP, jc exit code = \fB0\fP, combined exit code = \fB0\fP (no errors) -`ifconfig` exit code = `1`, `jc` exit code = `0`, combined exit code = `1` (error in `ifconfig`) +ifconfig exit code = \fB1\fP, jc exit code = \fB0\fP, combined exit code = \fB1\fP (error in ifconfig) -`ifconfig` exit code = `0`, `jc` exit code = `100`, combined exit code = `100` (error in `jc`) +ifconfig exit code = \fB0\fP, jc exit code = \fB100\fP, combined exit code = \fB100\fP (error in jc) -`ifconfig` exit code = `1`, `jc` exit code = `100`, combined exit code = `101` (error in both `ifconfig` and `jc`) +ifconfig exit code = \fB1\fP, jc exit code = \fB100\fP, combined exit code = \fB101\fP (error in both ifconfig and jc) .RE .SH ENVIRONMENT diff --git a/templates/readme_template b/templates/readme_template index f077b5e3..501440a1 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -132,13 +132,16 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio - `-v` version information ### Exit Codes -Any fatal errors within `jc` will generate an exit code of `100`, otherwise the exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`), `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 tell if an error was from the parsed program or `jc`. +Any fatal errors within `jc` will generate an exit code of `100`, otherwise the exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`), `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`: -- `ifconfig` exit code = `0`, `jc` exit code = `0`, combined exit code = `0` (no errors) -- `ifconfig` exit code = `1`, `jc` exit code = `0`, combined exit code = `1` (error in `ifconfig`) -- `ifconfig` exit code = `0`, `jc` exit code = `100`, combined exit code = `100` (error in `jc`) -- `ifconfig` exit code = `1`, `jc` exit code = `100`, combined exit code = `101` (error in both `ifconfig` and `jc`) +| `ifconfig` exit code | `jc` exit code | Combined exit code | Interpretation | +|----------------------|----------------|--------------------|------------------------------------| +| `0` | `0` | `0` | No errors | +| `1` | `0` | `1` | Error in `ifconfig` | +| `0` | `100` | `100` | Error in `jc` | +| `1` | `100` | `101` | Error in both `ifconfig` and `jc` | + ### Setting Custom Colors via Environment Variable You can specify custom colors via the `JC_COLORS` environment variable. The `JC_COLORS` environment variable takes four comma separated string values in the following format: