fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-17 19:48:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix syntax highlighting in command line reference, clean up content a bit, include --diagnostic

Browse source
This commit is contained in:
Micah Jerome Ellison 2022-01-08 13:07:50 -08:00
parent b77a24bcf1
commit e4dde5d1c0
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/reference-command-line.md
View file

@ -37,15 +37,14 @@ Import entries from another journal. If any entries have the exact same content
and timestamp, they will be deduplicated. and timestamp, they will be deduplicated.
Optional parameters: Optional parameters:
``` ```sh
--file FILENAME --file FILENAME
``` ```
Specify a file to import. If not provided, `jrnl` will use STDIN as the data source. Specify a file to import. If not provided, `jrnl` will use STDIN as the data source.
```sh
--format TYPE
``` ```
--format [jrnl]
```
Specify the format of the file that is being imported. Defaults to the same data Specify the format of the file that is being imported. Defaults to the same data
storage method that jrnl uses. See [formats](formats.md) for more information. storage method that jrnl uses. See [formats](formats.md) for more information.
@ -95,7 +94,7 @@ each entry.
Display selected entries in an alternate format. See [formats](formats.md). Display selected entries in an alternate format. See [formats](formats.md).
#### Optional parameters #### Optional parameters
``` ```sh
--file FILENAME --file FILENAME
``` ```
Write output to file instead of STDOUT. In most shells, the Write output to file instead of STDOUT. In most shells, the
@ -114,12 +113,17 @@ Only shows the date and titles of the searched entries.
### --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR ### --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR
Override configured key-value pair with CONFIG_KV_PAIR for this command invocation only. Override configured key-value pair with CONFIG_KV_PAIR for this command invocation only.
Read [advanced usage](./advanced.md) for examples.
### --config-file CONFIG_FILE_PATH ### --config-file CONFIG_FILE_PATH
Use the config file at CONFIG_FILE_PATH for this command invocation only. Use the config file at CONFIG_FILE_PATH for this command invocation only.
Read [advanced usage](./advanced.md) for examples.
## Other Arguments ## Other Arguments
### --debug ### --debug
Prints information useful for troubleshooting. Prints information useful for troubleshooting while `jrnl` executes.
### --diagnostic
Prints diagnostic information useful for [reporting issues](https://github.com/jrnl-org/jrnl/issues).