From 5b40a97ce417687b4e37f320b8a3f07dd7fd169c Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 25 Apr 2021 20:55:43 -0700 Subject: [PATCH] add caveats to man page --- jc/man/jc.1.gz | Bin 2087 -> 2413 bytes man/jc.1.gz | Bin 2087 -> 2413 bytes templates/manpage_template | 13 +++++++++++++ 3 files changed, 13 insertions(+) diff --git a/jc/man/jc.1.gz b/jc/man/jc.1.gz index 5dbd9eacc7efa2447e797cd52b559b38267b00eb..e433338a73ba2862031a26b0d47f537f1f6054dd 100644 GIT binary patch literal 2413 zcmV-z36l07iwFpnIfh^Y|7v3{F#w%eQE%Hg5`NdOAc6%h0b;rBT^G3E_HeF~ZM>V< zM&x!|v_(Tpl+8pERg#LM#s2u68B(@vBvNn>iD#s5hQr}-h8%^9OLiBt*X+%!H?Ie; z{xx{>mc0&NzYYJ%j(&?~Q#QVuFjd*IvaGT)leRtz!swDsN7oktNPZnK#K}|&!|Yl# zV3o3*7d6RSr82{Kk+4)|Vqoi17*Y~_p3dgcBnrl}>+8|Hxqh=sQ=42mcodF8!0p^xi+#`FV||7$P}hUsf7_R4J%cFmY`km z>_Mu^uvq0_S@I9lm}-^RIQy^wl_48tR_FqxA4FE4lJpTd=g519#k^ok!72lWEo;gF~_Iig28~t zr34oQw@BP>wU;Du0F@d?aA-%f!Q@3U1G6t>dZcve@Ve{UC?W?-NMIf)HR!~^>R|70w_ zF?`W2eW#XgFeJL6_q4-)7xnNX&nof!Br`mw52lB)bTAd`F0vkjw~< zgkK*df9@GamV-?Cr3Ho|(=TGyJ{6$|GCd+L3d)`+fE4HpBvC!!G9UbK2O=OD(B1gM z{Mnm6jWgQx7`=^x{tz&=iLEP>j_ie7k+&oq_d=mTcDFA_OFQUK2`vrgDGf%&_rkth zNtHgOr7EPQy8R+WvPe}+3$oo}R^~2}hLzF7r7VW{q+bS4W{t;NJj2DUdQ7#N!=;E@ zS9G_W-;7)S=ND+%?SviM) zbe)sY?qYs1{W!UqO|LJei{P`Ws4HMf5zDk@aRuj8JSJyK8}=YMH3LBBZ{zRd+12bO zLZ`shMZ#?ooxvWsmU#9H+2VyrX8Ap}V=C?9jTuNG8gfzsTUujJ;{lIt2HP_@e5$fc zZSc99$ypF=2l?ec_oBwd`c5|g_Z0b!(#e)Ds(c9x+OTc}&j!ICYoSFmU#`U&PGOlr zpn&7~Ie~UtyRuY+UnVr-9d75iM71yEm45)Edz}*c;b9 zIvCxn+S%Zq99ZHWw(Z%hrFAk8=fEc-+4r$!x&JqxU*EI&C({wa~@&FZ*vqWkrlW=W2@-rN;D_K;J zLn!l)6evGk&aN+pAqnEyON-&b7y$_7Jf1}@{FPj4uIu4wSAAII+AmLu{~-%F(;27W zYBnBSjpp<7(PH%V>s{RZwM58YS5J8bdv#DWi-c=P@wHvUz;M^7GIvEXA^TuNv*YjZ zd`?P-sZwEyaoZ^5*!qMc3;5Rxs^CTfQ#*${XL|`M0)8Wt)|UTGwRB4mZVe_&NeDMJ zEF>&4t|Vjxd1x~ss9UOCC7mte4Khhoxeogxkb$EPmWr~Y*Qp1tGX;PdV4h|;c?^+7)R zcrjW;n8(Q+afY74y|@%GE2s%zhH;zGx%6r@eUBK5Lh($>rH=EMn$3IrT1a#swv<7m z#T@I5N52*APB2`k3IY27gOK5nzl?FR!nOBzZ9wengEsMq;f(rx%4nPA`^>s3u(UNJ zm`1yk^@EU3c)Wl^(VwaihWrs>ne~yx*8Bm?w51#8bH7o8CF?-2&doz&Bg`u_sYgDV$)PUGHJ0fPLT%DD-bOopadSv5dJSYw%5J; zTvD;#`sUk!JMr%}MQd+uU`+4~$YUpc0>R5ZEXF$xzKNd*Jj1)>hH9*Mw2k)W6z3-C zz9;PFw~<+f8nznw1``7ckSCv-u%8UnR&or?RD`P#f#htDK4DYE6a`eH+$Wvp;{ctf z+<04qjQ?P8@o98Dzq*Kms7XdT#-cEgr`Yvm!94djN9Ga2ARGVybDF0K literal 2087 zcmV+?2-x=@iwFn^IEG*X|7v3{F#w%eZExE+68^4VK?Dn23Pg6(+b*!d-QnCMyYXK9 zg2?T*Xo`lGD4U5Ssw5RhhyC$4Go)WtEkgwDnOih_2XlG`S2w@-}3Mlc^Mj*|liE zDrGq@YLd4~Wrp!0VX4eSXzNlKQWAZc&gRiL3eIPf$!L1P{z7NwqnqgRhJBsQ7vtG9 z`W6IAgR+&3nW+oQpUwiby#3C+bU->UE~E3CF?~YR|K%J@!J^W_bWU2GNw7e!FfB?gjDTrasS5N2{erPa zsVc)_m4j!=-%R7GRbJ!l;{sF;*eJ6?7a;v8vigLik0>}tJ~}Ms1zQSM8E|Y_qwZ1^ z3C;oh27M^v?I62Eu6PvMie$iMCHiF=B_%hg24Em7^IRm7TQCgYAVy+Omo#hzUKIm& zJXKblZ9ni#asyH2AW$gFOjVW&&Al18HS;SO3_b*N2)EGYEEwEG0eoG|aTG!jhCD7M zgdn&>;%=+GB#8s4)M&w>9nHe=t7Jm6FJ*e9bm{QA>;^8g2bmC*sBUolV5*$JMBPy) z-4WF(rWIts(g`|xC(xvLmt8fhVvL0Yen{F?e&JDV9)9Q=gYxuE)GIR_WS_IJ!qb8Eba2 zAhshCzVh^y9htUVZ5L)K4Sk>;_8(CXKk=**FHa)l#+@ff_=1e&vRi-V9LY={3{C})1ga05tHgtW z>I19PV^vQv%~e&nITFW{(vN^2VCai4|gE~k^$X~Kdhg< z<;Q;#zR3>A3wSDW+Q*a-9 zqFBg#@TJ=L8<`{f;M=uzWH;Q!pr<}NFtUMT*|3XGs>SOk001E0T4kC zes}^el@U9@o+3)>wa7{*wq|%np}*h#a+3~!Sxi)1<;^31PYqo$b5*E#tySK1B-#kN z6T_q3T70|9!ajqcgY-uwg~eIHb4&|k*oNx@PCU~_QeJ7kVXXkQzti;xW^S+>ftjvz za@sx2FQ=czH?!&Fa=Hk{=Gp(-4mN zCrXr`u4a?V;eZ73?xn@>z(xQe35DDkyjgJF1URGE7snF0G~M6=`X@qSK9 zhpAG767#lE$g%YaR~Cq`6?B3d2~6z*?t<+l=n(K5nY6azZ>ptRg2C2d@|1*dQ^P{S zBI8OzMUaO+6N0*>+BGf-3=dobcQGhE7S<1ZQYqtEx#my^gqE@E3qu&Rb?qZH@=Xw|tu4*j zaJYg+sg^i6+(*OC@P%MD|8g__{b~`MtFop#!;a%O?A_bbUqk$(2WuOJ+>)^<46GKL Rj2Fyv{{wAa5JM&z005Ck`E&pP diff --git a/man/jc.1.gz b/man/jc.1.gz index 5dbd9eacc7efa2447e797cd52b559b38267b00eb..e433338a73ba2862031a26b0d47f537f1f6054dd 100644 GIT binary patch literal 2413 zcmV-z36l07iwFpnIfh^Y|7v3{F#w%eQE%Hg5`NdOAc6%h0b;rBT^G3E_HeF~ZM>V< zM&x!|v_(Tpl+8pERg#LM#s2u68B(@vBvNn>iD#s5hQr}-h8%^9OLiBt*X+%!H?Ie; z{xx{>mc0&NzYYJ%j(&?~Q#QVuFjd*IvaGT)leRtz!swDsN7oktNPZnK#K}|&!|Yl# zV3o3*7d6RSr82{Kk+4)|Vqoi17*Y~_p3dgcBnrl}>+8|Hxqh=sQ=42mcodF8!0p^xi+#`FV||7$P}hUsf7_R4J%cFmY`km z>_Mu^uvq0_S@I9lm}-^RIQy^wl_48tR_FqxA4FE4lJpTd=g519#k^ok!72lWEo;gF~_Iig28~t zr34oQw@BP>wU;Du0F@d?aA-%f!Q@3U1G6t>dZcve@Ve{UC?W?-NMIf)HR!~^>R|70w_ zF?`W2eW#XgFeJL6_q4-)7xnNX&nof!Br`mw52lB)bTAd`F0vkjw~< zgkK*df9@GamV-?Cr3Ho|(=TGyJ{6$|GCd+L3d)`+fE4HpBvC!!G9UbK2O=OD(B1gM z{Mnm6jWgQx7`=^x{tz&=iLEP>j_ie7k+&oq_d=mTcDFA_OFQUK2`vrgDGf%&_rkth zNtHgOr7EPQy8R+WvPe}+3$oo}R^~2}hLzF7r7VW{q+bS4W{t;NJj2DUdQ7#N!=;E@ zS9G_W-;7)S=ND+%?SviM) zbe)sY?qYs1{W!UqO|LJei{P`Ws4HMf5zDk@aRuj8JSJyK8}=YMH3LBBZ{zRd+12bO zLZ`shMZ#?ooxvWsmU#9H+2VyrX8Ap}V=C?9jTuNG8gfzsTUujJ;{lIt2HP_@e5$fc zZSc99$ypF=2l?ec_oBwd`c5|g_Z0b!(#e)Ds(c9x+OTc}&j!ICYoSFmU#`U&PGOlr zpn&7~Ie~UtyRuY+UnVr-9d75iM71yEm45)Edz}*c;b9 zIvCxn+S%Zq99ZHWw(Z%hrFAk8=fEc-+4r$!x&JqxU*EI&C({wa~@&FZ*vqWkrlW=W2@-rN;D_K;J zLn!l)6evGk&aN+pAqnEyON-&b7y$_7Jf1}@{FPj4uIu4wSAAII+AmLu{~-%F(;27W zYBnBSjpp<7(PH%V>s{RZwM58YS5J8bdv#DWi-c=P@wHvUz;M^7GIvEXA^TuNv*YjZ zd`?P-sZwEyaoZ^5*!qMc3;5Rxs^CTfQ#*${XL|`M0)8Wt)|UTGwRB4mZVe_&NeDMJ zEF>&4t|Vjxd1x~ss9UOCC7mte4Khhoxeogxkb$EPmWr~Y*Qp1tGX;PdV4h|;c?^+7)R zcrjW;n8(Q+afY74y|@%GE2s%zhH;zGx%6r@eUBK5Lh($>rH=EMn$3IrT1a#swv<7m z#T@I5N52*APB2`k3IY27gOK5nzl?FR!nOBzZ9wengEsMq;f(rx%4nPA`^>s3u(UNJ zm`1yk^@EU3c)Wl^(VwaihWrs>ne~yx*8Bm?w51#8bH7o8CF?-2&doz&Bg`u_sYgDV$)PUGHJ0fPLT%DD-bOopadSv5dJSYw%5J; zTvD;#`sUk!JMr%}MQd+uU`+4~$YUpc0>R5ZEXF$xzKNd*Jj1)>hH9*Mw2k)W6z3-C zz9;PFw~<+f8nznw1``7ckSCv-u%8UnR&or?RD`P#f#htDK4DYE6a`eH+$Wvp;{ctf z+<04qjQ?P8@o98Dzq*Kms7XdT#-cEgr`Yvm!94djN9Ga2ARGVybDF0K literal 2087 zcmV+?2-x=@iwFn^IEG*X|7v3{F#w%eZExE+68^4VK?Dn23Pg6(+b*!d-QnCMyYXK9 zg2?T*Xo`lGD4U5Ssw5RhhyC$4Go)WtEkgwDnOih_2XlG`S2w@-}3Mlc^Mj*|liE zDrGq@YLd4~Wrp!0VX4eSXzNlKQWAZc&gRiL3eIPf$!L1P{z7NwqnqgRhJBsQ7vtG9 z`W6IAgR+&3nW+oQpUwiby#3C+bU->UE~E3CF?~YR|K%J@!J^W_bWU2GNw7e!FfB?gjDTrasS5N2{erPa zsVc)_m4j!=-%R7GRbJ!l;{sF;*eJ6?7a;v8vigLik0>}tJ~}Ms1zQSM8E|Y_qwZ1^ z3C;oh27M^v?I62Eu6PvMie$iMCHiF=B_%hg24Em7^IRm7TQCgYAVy+Omo#hzUKIm& zJXKblZ9ni#asyH2AW$gFOjVW&&Al18HS;SO3_b*N2)EGYEEwEG0eoG|aTG!jhCD7M zgdn&>;%=+GB#8s4)M&w>9nHe=t7Jm6FJ*e9bm{QA>;^8g2bmC*sBUolV5*$JMBPy) z-4WF(rWIts(g`|xC(xvLmt8fhVvL0Yen{F?e&JDV9)9Q=gYxuE)GIR_WS_IJ!qb8Eba2 zAhshCzVh^y9htUVZ5L)K4Sk>;_8(CXKk=**FHa)l#+@ff_=1e&vRi-V9LY={3{C})1ga05tHgtW z>I19PV^vQv%~e&nITFW{(vN^2VCai4|gE~k^$X~Kdhg< z<;Q;#zR3>A3wSDW+Q*a-9 zqFBg#@TJ=L8<`{f;M=uzWH;Q!pr<}NFtUMT*|3XGs>SOk001E0T4kC zes}^el@U9@o+3)>wa7{*wq|%np}*h#a+3~!Sxi)1<;^31PYqo$b5*E#tySK1B-#kN z6T_q3T70|9!ajqcgY-uwg~eIHb4&|k*oNx@PCU~_QeJ7kVXXkQzti;xW^S+>ftjvz za@sx2FQ=czH?!&Fa=Hk{=Gp(-4mN zCrXr`u4a?V;eZ73?xn@>z(xQe35DDkyjgJF1URGE7snF0G~M6=`X@qSK9 zhpAG767#lE$g%YaR~Cq`6?B3d2~6z*?t<+l=n(K5nY6azZ>ptRg2C2d@|1*dQ^P{S zBI8OzMUaO+6N0*>+BGf-3=dobcQGhE7S<1ZQYqtEx#my^gqE@E3qu&Rb?qZH@=Xw|tu4*j zaJYg+sg^i6+(*OC@P%MD|8g__{b~`MtFop#!;a%O?A_bbUqk$(2WuOJ+>)^<46GKL Rj2Fyv{{wAa5JM&z005Ck`E&pP diff --git a/templates/manpage_template b/templates/manpage_template index f7f99106..e8852f5c 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -96,6 +96,19 @@ Local plugin filenames must be valid python module names, therefore must consist Note: The application data directory follows the XDG Base Directory Specification +.SH CAVEATS +\fBLocale:\fP For best results set the \fBLANG\fP locale environment variable to \fBC\fP. For example, either by setting directly on the command-line: + +\fB$ LANG=C date | jc --date\fP + +or by exporting to the environment before running commands: + +\fB$ export LANG=C\fP + +\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). + +If a UTC timezone can be detected in the text of the command output, the timestamp will be timezone aware and have a \fB_utc\fP suffix on the key name. (e.g. \fBepoch_utc\fP) No other timezones are supported for aware timestamps. + .SH EXAMPLES Standard Syntax: .RS