From cd5547dfd8c03973ca3cbbc9201453c98f77483e Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sat, 30 Jul 2022 12:23:43 -0700 Subject: [PATCH] doc update --- CHANGELOG | 2 +- man/jc.1 | 14 +++++++++----- templates/manpage_template | 12 ++++++++---- 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 6bad6dfa..7192d0e7 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -4,7 +4,7 @@ xxxxxxxx v1.20.5 - Add IP Address string parser - Fix `lsusb` command parser for output containing a `Device Qualifier` and `Binary Object Store Descriptor` sections -- Change LANG=C to LC_ALL=C in locale instructions +- Change `LANG=C` to `LC_ALL=C` in locale instructions - Add `__main__.py` to package allowing `python -m jc` usage 20220723 v1.20.4 diff --git a/man/jc.1 b/man/jc.1 index 485123e5..366b1da3 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2022-07-29 1.20.5 "JSON Convert" +.TH jc 1 2022-07-30 1.20.5 "JSON Convert" .SH NAME \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types .SH SYNOPSIS @@ -758,19 +758,23 @@ 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: +For best results set the locale environment variables to \fBC\fP or +\fBen_US.UTF-8\fP by modifying the \fBLC_ALL\fP variable: .RS -$ LANG=C date | jc \fB--date\fP +$ LC_ALL=C date | jc \fB--date\fP .RE -or by exporting to the environment before running commands: +You can also set the locale variables individually: .RS $ export LANG=C + +$ export LC_NUMERIC=C .RE -On some older systems UTF-8 output will be downgraded to ASCII with \fB\\u\fP escape sequences if the \fBC\fP locale does not support UTF-8 encoding. +On some older systems UTF-8 output will be downgraded to ASCII with \fB\\u\fP +escape sequences if the \fBC\fP locale does not support UTF-8 encoding. \fBTimezones\fP diff --git a/templates/manpage_template b/templates/manpage_template index f5ed2d21..e027125a 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -203,19 +203,23 @@ 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: +For best results set the locale environment variables to \fBC\fP or +\fBen_US.UTF-8\fP by modifying the \fBLC_ALL\fP variable: .RS -$ LANG=C date | jc \fB--date\fP +$ LC_ALL=C date | jc \fB--date\fP .RE -or by exporting to the environment before running commands: +You can also set the locale variables individually: .RS $ export LANG=C + +$ export LC_NUMERIC=C .RE -On some older systems UTF-8 output will be downgraded to ASCII with \fB\\u\fP escape sequences if the \fBC\fP locale does not support UTF-8 encoding. +On some older systems UTF-8 output will be downgraded to ASCII with \fB\\u\fP +escape sequences if the \fBC\fP locale does not support UTF-8 encoding. \fBTimezones\fP