From 934941332f91d9e2cc4e691b154bb5427166ed30 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 28 Apr 2021 11:50:10 -0700 Subject: [PATCH 1/2] minor link updates --- README.md | 6 +++--- templates/readme_template | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8ee053b8..497d6de0 100644 --- a/README.md +++ b/README.md @@ -224,7 +224,7 @@ Custom local parser plugins may be placed in a `jc/jcparsers` folder in your loc Local parser plugins are standard python module files. Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder. -Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default plugins. +Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default parsers. > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) @@ -247,7 +247,7 @@ Some parsers have calculated epoch timestamp fields added to the output. Unless If a UTC timezone can be detected in the text of the command output, the timestamp will be timezone aware and have a `_utc` suffix on the key name. (e.g. `epoch_utc`) No other timezones are supported for aware timestamps. ## Compatibility -Some parsers like `ls`, `ps`, `dig`, etc. will work on any platform. Other parsers that are platform-specific will generate a warning message if they are used on an unsupported platform. To see all parser information, including compatibility, run `jc -ap`. +Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other parsers that convert platform-specific output will generate a warning message if they are run on an unsupported platform. To see all parser information, including compatibility, run `jc -ap`. You may still use a parser on an unsupported platform - for example, you may want to parse a file with linux `lsof` output on an macOS laptop. In that case you can suppress the warning message with the `-q` cli option or the `quiet=True` function parameter in `parse()`: @@ -269,7 +269,7 @@ Tested on: ## Contributions Feel free to add/improve code or parsers! You can use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and submit your parser with a pull request. -Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information. +Please see the [Contributing Guidelines](https://kellyjonbrazil.github.io/jc/CONTRIBUTING.md) for more information. ## Acknowledgments - Local parser plugin feature contributed by [Dean Serenevy](https://github.com/duelafn) diff --git a/templates/readme_template b/templates/readme_template index c1ce7f40..8d906e1c 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -152,7 +152,7 @@ Custom local parser plugins may be placed in a `jc/jcparsers` folder in your loc Local parser plugins are standard python module files. Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder. -Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default plugins. +Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default parsers. > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) @@ -175,7 +175,7 @@ Some parsers have calculated epoch timestamp fields added to the output. Unless If a UTC timezone can be detected in the text of the command output, the timestamp will be timezone aware and have a `_utc` suffix on the key name. (e.g. `epoch_utc`) No other timezones are supported for aware timestamps. ## Compatibility -Some parsers like `ls`, `ps`, `dig`, etc. will work on any platform. Other parsers that are platform-specific will generate a warning message if they are used on an unsupported platform. To see all parser information, including compatibility, run `jc -ap`. +Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other parsers that convert platform-specific output will generate a warning message if they are run on an unsupported platform. To see all parser information, including compatibility, run `jc -ap`. You may still use a parser on an unsupported platform - for example, you may want to parse a file with linux `lsof` output on an macOS laptop. In that case you can suppress the warning message with the `-q` cli option or the `quiet=True` function parameter in `parse()`: @@ -197,7 +197,7 @@ Tested on: ## Contributions Feel free to add/improve code or parsers! You can use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and submit your parser with a pull request. -Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information. +Please see the [Contributing Guidelines](https://kellyjonbrazil.github.io/jc/CONTRIBUTING.md) for more information. ## Acknowledgments - Local parser plugin feature contributed by [Dean Serenevy](https://github.com/duelafn) From bd428a9fd75327710dce96f3c95f74ab9d1beaad Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 28 Apr 2021 11:52:24 -0700 Subject: [PATCH 2/2] fix link --- README.md | 2 +- templates/readme_template | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 497d6de0..caa12b67 100644 --- a/README.md +++ b/README.md @@ -269,7 +269,7 @@ Tested on: ## Contributions Feel free to add/improve code or parsers! You can use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and submit your parser with a pull request. -Please see the [Contributing Guidelines](https://kellyjonbrazil.github.io/jc/CONTRIBUTING.md) for more information. +Please see the [Contributing Guidelines](https://kellyjonbrazil.github.io/jc/CONTRIBUTING) for more information. ## Acknowledgments - Local parser plugin feature contributed by [Dean Serenevy](https://github.com/duelafn) diff --git a/templates/readme_template b/templates/readme_template index 8d906e1c..aa18d1a4 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -197,7 +197,7 @@ Tested on: ## Contributions Feel free to add/improve code or parsers! You can use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and submit your parser with a pull request. -Please see the [Contributing Guidelines](https://kellyjonbrazil.github.io/jc/CONTRIBUTING.md) for more information. +Please see the [Contributing Guidelines](https://kellyjonbrazil.github.io/jc/CONTRIBUTING) for more information. ## Acknowledgments - Local parser plugin feature contributed by [Dean Serenevy](https://github.com/duelafn)