From 37223f086cabc8db5962415bd161fed151dafb9d Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 23 Sep 2021 21:13:21 -0700 Subject: [PATCH] formatting --- README.md | 5 +++-- templates/readme_template | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b2e0f6fb..172707c9 100644 --- a/README.md +++ b/README.md @@ -297,7 +297,8 @@ Local plugin filenames must be valid python module names, therefore must consist > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) ### Caveats -**Locale:** + +#### Locale: For best results set the `LANG` locale environment variable to `C` or `en_US.UTF-8`. For example, either by setting directly on the command-line: ``` @@ -308,7 +309,7 @@ or by exporting to the environment before running commands: $ export LANG=C ``` -**Timezones:** +#### Timezones: Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a `_utc` suffix it is considered naive. (i.e. based on the local timezone of the system the `jc` parser was run on). diff --git a/templates/readme_template b/templates/readme_template index 6c34147c..b8a9332d 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -220,7 +220,8 @@ Local plugin filenames must be valid python module names, therefore must consist > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) ### Caveats -**Locale:** + +#### Locale: For best results set the `LANG` locale environment variable to `C` or `en_US.UTF-8`. For example, either by setting directly on the command-line: ``` @@ -231,7 +232,7 @@ or by exporting to the environment before running commands: $ export LANG=C ``` -**Timezones:** +#### Timezones: Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a `_utc` suffix it is considered naive. (i.e. based on the local timezone of the system the `jc` parser was run on).