From 995ecc9bfb0425b0ee9e4250395b0200b46c1e89 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 11 May 2021 11:11:17 -0700 Subject: [PATCH] add exit codes section --- jc/man/jc.1.gz | Bin 2412 -> 2663 bytes man/jc.1.gz | Bin 2412 -> 2663 bytes templates/manpage_template | 15 +++++++++++++++ 3 files changed, 15 insertions(+) diff --git a/jc/man/jc.1.gz b/jc/man/jc.1.gz index db001ebecc771660ddb2b08f6e954e361ac936e2..ec57ac5680aab1ad75fbc247478f8e33668a66ca 100644 GIT binary patch literal 2663 zcmV-t3YhgDiwFpc$eLgR|7v3{F#w%eZExE+68`RAK?Dn23dC|!To>5jdN|j~ZoQk> zLF{&0v_(xzw9P~kRg#LM#r^o37s{56#LC`>#6#(s7mkL*88Vu_7k9BZ6R%HSpLI{) zbkEMjS##XnZpnPCA3}^>u%AA^wZT-1KiJm$%}}_+~mB zk0#$b9b-Y*QpdtoxtEXU9n`#eF9LUmWL{iO2Dd|cg{c3_II#eYN;<8qD5P~dUkaTI z7h7F;7om|djup_N(1l9iC5l~GlZmg3ca!PGaP)O?LsD5KXdqLBRfSbf!8E)!Ia-2t z!LtW#N+)8Ifn~`*Ty3g1LE`ws6hua%pL%6;;C@hPbwb=n)zeV8E-hOeI=+Pz>+DM`}lwc47%u z<&iiZ8L!SaFJ!8v1FuS8$c-1SEDD3_UPb)P!k6qs?>aZ&Ze`thC%T<<;O+DVpMndz zT^Sb|T+o>zG22Klh+_|`Eoxvi)1o_k5l`3ca=8{RTQJ@hhk^6-UMB=4>M%IIcV$Lk zqGl9HGolW%SpyL;XGW&C40VVf;_Q~YybZiqYrn#vvi0}dli(hZcQE<*yp{xFhZG=j zcq++)fr}QHUNTNE+kiFzZ3{5diHc1U46R2kOvU}On=%KGqMNqh+0RLN7^ZUa=?s1k z1JUDzM4}CvFO>~oBwOHC1<63PKwTYsJ>}yb4QI~>!_u0v*urUe2<}!gG3y2cKRCd$ zl5RzKBo5n-h_K`Wxd#`=vn+XoEARvsB4CIDJEB*6l41?%bP?imGip(71#?L1hS)gEt*1%BMJ#Z+%4 zG)2<$rn?!1#kd*&`~oT4m9QN)<X^E= zZ!L0i8GKKa=*kv+Vb-A{W3mmt`L;|RhO-Y^^3ytIRNMkvv1j1-Fz_*>2>Nt=^?Z7% zB!fQp_fgRMU3Q`yf`)!H^n(q4iM(ys8=d2m~AC+k3xIDhtEwiLa~^bxXkJ%e@6_Jn3>5% zPb8WMs)?a#_a1w9o%<&+w2}TOwemPCXveH_POPQPVaIb#B*m4LYte8}^F5V6Fms2e z5g6$U8$%q+th^&-*$y=PYJvWd_<%0eviPjAfDt?d#JKlC@!u#1v|B@NR_=pu))zf)(h~ z3z{){1wf9Efk+$6ua&}U6dZLr1BhtoD=ncGCQZ#6?NN_1D_}zi^WRqB=N$_FMoGS% z*<1A6$)3seQ&^*r`oV_1H{v)q;X6Y6@|@hWzbW?&p`W^s(LgBgKHX60H)G<7*{giN|4ot#p>nC@95%3 z4UPO@M=w9x(;h@^ZQv(+mhi)-J?oYB%md*A<3ufFnNoS&`4!KUd4-=~?r>_8Zvrg% zEv)wKH$g*A8q+%ocAU^e@OZrW1%t4YXMVSVJNPh}j<3UU`=m4ASWQg~IX>)TMOrR( z?nEXlIt>QxblNQ>&h9Sm-NlS_yaA?|)Zlf6!N`)1`cOha6)8ocEtHbRR!3omU2&!J z^05b{@FNAvPw&Uqm%WG>u|Kh@x2K~6OqqExBm!l1%y%c?2J88VSc(*C z7cfFJZQvL(P-$4$`8E+BUV_1VWq?VqQEBf5PDovRm-Ff3H}Ot_gD*C(CzN&rZwT`K z$IJe7g0&8rqt4M&xEALMW(9Q36`QElEg|rfSEFl%ak?|RY0*Su+xCAoD~pFDoq@g zOnfu6y;y^Q&r_^KTUe2SXMi7Xn}!g);=^>Xl@Knv5`}#(CpQ%1)uXSa*PRYelJDHM z^Q+6(jYPS|#DEOs$)_e9CIfpbIVK8)Eda^c0sTsh3|Gw?;UVeN7iiRTu)d8!E~;zy z{`JijRPK{HMNPu(DdygvATXC=ybSjSTadc<$IgS6b%%o0HB~*he z?+bU{>n&k1mUDdA+eO2k5VFJg=JW0FxA#*h$%~41SaBS`60c9se(BzVPB@R`FJ{s zzXgHPplm4aJSIrJcw@M0N&1L_!L|ahCHbx zxFEPi;&!9GB8fey)Hs4eJDP>#7s-TXSIYEA>B`}Cbr`tF?`29*q7H+Tds7z#ChC?V z>6WO2Vp>52ES#XDw*qa5ACe5~UD*zvt)*RIQ0aF4_B5CWlpVz%pC2WK*r5TCI6Rd! zbHJ zJQ9a(M}*&Up4@}8k%0z0CUJxz&(bej3N+;Ba^OJkL8oQR`)1eCF6 z>kDEJc*19%zO*B=j_EDaBT`aM9#6&xMz0_ea^dW4nI5(4&_D@t5^I)<2lfU2$wYi( z_~Nkiom#lTkT?vzrycf}Xa*m7UW?}^k#pnf2@*abBe^)NKX-=YrVj>H!6Sj{0~adw zV4(WID)U&?lS~U$mu`+k9R`=e!UlJ6PxlDe>W4!E!NQ($i3g8$x{Ywh9|-XZk{Q8~ z@au!*&pqSFD$J!{T3{G5{UT=NQxS?F(<9=dpz4VNNP)gU64e8)itvX!5CO@6K8)Yb zpS|hRIHOIE(VHmf4*}Dd#JV!+$X>V=MMuJMFBA&%yInb2+OR(*bTpW!G#HiK3;S{< zb@r5&x|Ejc_KOtBGE*Hb$Q~B6vT%_!sEr;hWI4bm{W5qmYdzlK87^+!W2)60E=AnB zqPyYzX58>Uzd*}&Cv4fS9(vHDsLoup!|#jC2VBUjYU65@1D@dn_64Y1CUk52)}yE7 z-uFbYkoVv#we}}6NA|%tYwO6vaOZ=b{IpISD(Qi(oM+(oFz~UU2>Nt=^?Z71xC4D2 z?xW!DcNs)8g8KWYzYligIm+?{!~tGSkLhyl?#w4$7?qGzENVEEQ=(=RKMS7Rvtt4v zf-d}U1zsp4wtyW)6x1t`S59ojutuT1-~Dov4u4ooRZMLEZOs{DGMp>_%Xu z>w=7S7xT->$MMZ{a(y|O2cK0(>xL}m?3YB;CjF*#S-um{Ph82~!}9DN^6uckLK zIt8vS5^j^|4EDga#Is+-<}XAt%kQZjQ)?G*%s>j!kdso_(i(dj4|r@d*q*`RGnMCR zjnCao&Vyhx$Zx;iiv}0#JK6mEDe`Nj(+ywN#R3+zW!(s#4T8T{LW_33T#Iv@!Xk%2 z0rO9h(IRchC0v)vmT3f9)p83kxTOoe#4u^uq~YaO18+7WS}s?1XDs)qGopL2Gp>8I zH@a7~wZT2vv&22@+Ou9s>trC#flo!o>zqn|@CWwG9(hsa;uM=jM%cE~OBG~%tuAo1{_N~M?7`a%@Rl@Ujk5+lTl%-(> zZ>ZA+qf;l3ah%;1YV$0V*VCsnk#=;o5fOXBe_8S=NsO zDD#gLC_lZQUSAF(62!BY7K6Pp0uU;AGL1X*Xop7ILz>Y!+rDc6wV8@qym;jU5V?uuk0_Q8mD$KT=k zoRkhSrJ@SswpGZn^$AB7@UInA!Hoo_aSnIR_7YSC{6;3N9siqp;g%rU7)+Lu5N>K% zNLXZCNyrFt-)2Hkw^X~vC4u3BYv3#fsmH?lflVr7Jg-(95`oY%aeZNMgSM{y#aRw{ z8H`|E8(a)2$f8=N+lcos!C==8#iZ9cMeGHRPhGB0{psQzd&|MW7n|2HrCl%UgM9e$ zayXAMkCQp#96g15aUozD6%Z4lxvk;+d379p@1>n|JoLkmx>aDT79f zIo27Eek;43V7O3~0`>t0A;Tem8{uSyYwvH{fY{duZQ>Eb8TI*;(KXBWnRQ)aX=_I? zt#&8t2O*vCcn*i6e^e<9`6I?M>m!M+_yd^9^Q6wHh=>XbF~d_7ta4F7G>JTgWlvMr z_1=CofPgP^tg?I`PQeA5jSJ@QwM|^aW|@3s(qdzrA`PNfAX+{^2|Sh&{9kZvuY32o zq+-4G?Y9AU;@@tH&fZ$XnBWeff|q@mkG2|o6F(JrhIh#g)mZUpTkY*B&P~#N zPuR|HE%O{TY&7yUCI%EBPd+taKN+a4We9WcPY{?(wqCEJrBX{cZ@?s7>~(s^Y;)G4BzR5V zmv*&y0R%mv(aHVs%%N{j$EqE%?O4+h7iKd2Fn>S23I2i_-LSWs|08pDe2?6nDi_56 zXIXHWp8~^}ig`v&> diff --git a/man/jc.1.gz b/man/jc.1.gz index db001ebecc771660ddb2b08f6e954e361ac936e2..ec57ac5680aab1ad75fbc247478f8e33668a66ca 100644 GIT binary patch literal 2663 zcmV-t3YhgDiwFpc$eLgR|7v3{F#w%eZExE+68`RAK?Dn23dC|!To>5jdN|j~ZoQk> zLF{&0v_(xzw9P~kRg#LM#r^o37s{56#LC`>#6#(s7mkL*88Vu_7k9BZ6R%HSpLI{) zbkEMjS##XnZpnPCA3}^>u%AA^wZT-1KiJm$%}}_+~mB zk0#$b9b-Y*QpdtoxtEXU9n`#eF9LUmWL{iO2Dd|cg{c3_II#eYN;<8qD5P~dUkaTI z7h7F;7om|djup_N(1l9iC5l~GlZmg3ca!PGaP)O?LsD5KXdqLBRfSbf!8E)!Ia-2t z!LtW#N+)8Ifn~`*Ty3g1LE`ws6hua%pL%6;;C@hPbwb=n)zeV8E-hOeI=+Pz>+DM`}lwc47%u z<&iiZ8L!SaFJ!8v1FuS8$c-1SEDD3_UPb)P!k6qs?>aZ&Ze`thC%T<<;O+DVpMndz zT^Sb|T+o>zG22Klh+_|`Eoxvi)1o_k5l`3ca=8{RTQJ@hhk^6-UMB=4>M%IIcV$Lk zqGl9HGolW%SpyL;XGW&C40VVf;_Q~YybZiqYrn#vvi0}dli(hZcQE<*yp{xFhZG=j zcq++)fr}QHUNTNE+kiFzZ3{5diHc1U46R2kOvU}On=%KGqMNqh+0RLN7^ZUa=?s1k z1JUDzM4}CvFO>~oBwOHC1<63PKwTYsJ>}yb4QI~>!_u0v*urUe2<}!gG3y2cKRCd$ zl5RzKBo5n-h_K`Wxd#`=vn+XoEARvsB4CIDJEB*6l41?%bP?imGip(71#?L1hS)gEt*1%BMJ#Z+%4 zG)2<$rn?!1#kd*&`~oT4m9QN)<X^E= zZ!L0i8GKKa=*kv+Vb-A{W3mmt`L;|RhO-Y^^3ytIRNMkvv1j1-Fz_*>2>Nt=^?Z7% zB!fQp_fgRMU3Q`yf`)!H^n(q4iM(ys8=d2m~AC+k3xIDhtEwiLa~^bxXkJ%e@6_Jn3>5% zPb8WMs)?a#_a1w9o%<&+w2}TOwemPCXveH_POPQPVaIb#B*m4LYte8}^F5V6Fms2e z5g6$U8$%q+th^&-*$y=PYJvWd_<%0eviPjAfDt?d#JKlC@!u#1v|B@NR_=pu))zf)(h~ z3z{){1wf9Efk+$6ua&}U6dZLr1BhtoD=ncGCQZ#6?NN_1D_}zi^WRqB=N$_FMoGS% z*<1A6$)3seQ&^*r`oV_1H{v)q;X6Y6@|@hWzbW?&p`W^s(LgBgKHX60H)G<7*{giN|4ot#p>nC@95%3 z4UPO@M=w9x(;h@^ZQv(+mhi)-J?oYB%md*A<3ufFnNoS&`4!KUd4-=~?r>_8Zvrg% zEv)wKH$g*A8q+%ocAU^e@OZrW1%t4YXMVSVJNPh}j<3UU`=m4ASWQg~IX>)TMOrR( z?nEXlIt>QxblNQ>&h9Sm-NlS_yaA?|)Zlf6!N`)1`cOha6)8ocEtHbRR!3omU2&!J z^05b{@FNAvPw&Uqm%WG>u|Kh@x2K~6OqqExBm!l1%y%c?2J88VSc(*C z7cfFJZQvL(P-$4$`8E+BUV_1VWq?VqQEBf5PDovRm-Ff3H}Ot_gD*C(CzN&rZwT`K z$IJe7g0&8rqt4M&xEALMW(9Q36`QElEg|rfSEFl%ak?|RY0*Su+xCAoD~pFDoq@g zOnfu6y;y^Q&r_^KTUe2SXMi7Xn}!g);=^>Xl@Knv5`}#(CpQ%1)uXSa*PRYelJDHM z^Q+6(jYPS|#DEOs$)_e9CIfpbIVK8)Eda^c0sTsh3|Gw?;UVeN7iiRTu)d8!E~;zy z{`JijRPK{HMNPu(DdygvATXC=ybSjSTadc<$IgS6b%%o0HB~*he z?+bU{>n&k1mUDdA+eO2k5VFJg=JW0FxA#*h$%~41SaBS`60c9se(BzVPB@R`FJ{s zzXgHPplm4aJSIrJcw@M0N&1L_!L|ahCHbx zxFEPi;&!9GB8fey)Hs4eJDP>#7s-TXSIYEA>B`}Cbr`tF?`29*q7H+Tds7z#ChC?V z>6WO2Vp>52ES#XDw*qa5ACe5~UD*zvt)*RIQ0aF4_B5CWlpVz%pC2WK*r5TCI6Rd! zbHJ zJQ9a(M}*&Up4@}8k%0z0CUJxz&(bej3N+;Ba^OJkL8oQR`)1eCF6 z>kDEJc*19%zO*B=j_EDaBT`aM9#6&xMz0_ea^dW4nI5(4&_D@t5^I)<2lfU2$wYi( z_~Nkiom#lTkT?vzrycf}Xa*m7UW?}^k#pnf2@*abBe^)NKX-=YrVj>H!6Sj{0~adw zV4(WID)U&?lS~U$mu`+k9R`=e!UlJ6PxlDe>W4!E!NQ($i3g8$x{Ywh9|-XZk{Q8~ z@au!*&pqSFD$J!{T3{G5{UT=NQxS?F(<9=dpz4VNNP)gU64e8)itvX!5CO@6K8)Yb zpS|hRIHOIE(VHmf4*}Dd#JV!+$X>V=MMuJMFBA&%yInb2+OR(*bTpW!G#HiK3;S{< zb@r5&x|Ejc_KOtBGE*Hb$Q~B6vT%_!sEr;hWI4bm{W5qmYdzlK87^+!W2)60E=AnB zqPyYzX58>Uzd*}&Cv4fS9(vHDsLoup!|#jC2VBUjYU65@1D@dn_64Y1CUk52)}yE7 z-uFbYkoVv#we}}6NA|%tYwO6vaOZ=b{IpISD(Qi(oM+(oFz~UU2>Nt=^?Z71xC4D2 z?xW!DcNs)8g8KWYzYligIm+?{!~tGSkLhyl?#w4$7?qGzENVEEQ=(=RKMS7Rvtt4v zf-d}U1zsp4wtyW)6x1t`S59ojutuT1-~Dov4u4ooRZMLEZOs{DGMp>_%Xu z>w=7S7xT->$MMZ{a(y|O2cK0(>xL}m?3YB;CjF*#S-um{Ph82~!}9DN^6uckLK zIt8vS5^j^|4EDga#Is+-<}XAt%kQZjQ)?G*%s>j!kdso_(i(dj4|r@d*q*`RGnMCR zjnCao&Vyhx$Zx;iiv}0#JK6mEDe`Nj(+ywN#R3+zW!(s#4T8T{LW_33T#Iv@!Xk%2 z0rO9h(IRchC0v)vmT3f9)p83kxTOoe#4u^uq~YaO18+7WS}s?1XDs)qGopL2Gp>8I zH@a7~wZT2vv&22@+Ou9s>trC#flo!o>zqn|@CWwG9(hsa;uM=jM%cE~OBG~%tuAo1{_N~M?7`a%@Rl@Ujk5+lTl%-(> zZ>ZA+qf;l3ah%;1YV$0V*VCsnk#=;o5fOXBe_8S=NsO zDD#gLC_lZQUSAF(62!BY7K6Pp0uU;AGL1X*Xop7ILz>Y!+rDc6wV8@qym;jU5V?uuk0_Q8mD$KT=k zoRkhSrJ@SswpGZn^$AB7@UInA!Hoo_aSnIR_7YSC{6;3N9siqp;g%rU7)+Lu5N>K% zNLXZCNyrFt-)2Hkw^X~vC4u3BYv3#fsmH?lflVr7Jg-(95`oY%aeZNMgSM{y#aRw{ z8H`|E8(a)2$f8=N+lcos!C==8#iZ9cMeGHRPhGB0{psQzd&|MW7n|2HrCl%UgM9e$ zayXAMkCQp#96g15aUozD6%Z4lxvk;+d379p@1>n|JoLkmx>aDT79f zIo27Eek;43V7O3~0`>t0A;Tem8{uSyYwvH{fY{duZQ>Eb8TI*;(KXBWnRQ)aX=_I? zt#&8t2O*vCcn*i6e^e<9`6I?M>m!M+_yd^9^Q6wHh=>XbF~d_7ta4F7G>JTgWlvMr z_1=CofPgP^tg?I`PQeA5jSJ@QwM|^aW|@3s(qdzrA`PNfAX+{^2|Sh&{9kZvuY32o zq+-4G?Y9AU;@@tH&fZ$XnBWeff|q@mkG2|o6F(JrhIh#g)mZUpTkY*B&P~#N zPuR|HE%O{TY&7yUCI%EBPd+taKN+a4We9WcPY{?(wqCEJrBX{cZ@?s7>~(s^Y;)G4BzR5V zmv*&y0R%mv(aHVs%%N{j$EqE%?O4+h7iKd2Fn>S23I2i_-LSWs|08pDe2?6nDi_56 zXIXHWp8~^}ig`v&> diff --git a/templates/manpage_template b/templates/manpage_template index e8852f5c..49eee6ae 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -62,6 +62,21 @@ raw JSON output \fB-v\fP 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`. + +Consider the following examples using `ifconfig`: + +.RS +`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`) +.RE + .SH ENVIRONMENT You can specify custom colors via the \fBJC_COLORS\fP environment variable. The \fBJC_COLORS\fP environment variable takes four comma separated string values in the following format: