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

Apply minor changes suggested in PR review

Browse source
This commit is contained in:
Micah Jerome Ellison 2022-01-15 13:40:13 -08:00
parent 70cac42723
commit a014945f53
4 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/advanced.md
View file

@ -75,7 +75,7 @@ The `work` journal is encrypted, prints to `json` by default, and is edited usin
### Modifying Configurations from the Command line ### Modifying Configurations from the Command line
You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot-notation and `CONFIG_VALUE` is the (valid) desired override value. You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot notation and `CONFIG_VALUE` is the (valid) desired override value. The dot notation can be used to change config keys within other keys, such as `colors.title` for the `title` key within the `colors` key.
You can specify multiple overrides as multiple calls to `--config-override`. You can specify multiple overrides as multiple calls to `--config-override`.
!!! note !!! note
@ -110,7 +110,7 @@ jrnl --config-file ~/foo/jrnl/personal-config.yaml
# Use alternate configuration file for work-related entries # Use alternate configuration file for work-related entries
jrnl --config-file ~/foo/jrnl/work-config.yaml jrnl --config-file ~/foo/jrnl/work-config.yaml
# Use default configuration file (created on installation) # Use default configuration file (created on first run)
jrnl jrnl
``` ```

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

@ -7,7 +7,7 @@ usage: jrnl [--debug] [--help] [--version] [--list] [--encrypt] [--decrypt]
[-day DATE] [-year DATE] [-from DATE] [-to DATE] [-contains TEXT] [-day DATE] [-year DATE] [-from DATE] [-to DATE] [-contains TEXT]
[-and] [-starred] [-n [NUMBER]] [-not [TAG]] [--edit] [--delete] [-and] [-starred] [-n [NUMBER]] [-not [TAG]] [--edit] [--delete]
[--format TYPE] [--tags] [--short] [--format TYPE] [--tags] [--short]
[--config-override CONFIG_KV_PAIR CONFIG_KV_PAIR] [--config-override CONFIG_KEY CONFIG_VALUE]
[--config-file CONFIG_FILE_PATH] [--config-file CONFIG_FILE_PATH]
[[...]] [[...]]
``` ```
@ -110,10 +110,9 @@ Only shows the date and titles of the searched entries.
## Configuration arguments ## Configuration arguments
### --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR ### --config-override CONFIG_KEY CONFIG_VALUE
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. To access config keys that aren't at the top level, separate the keys with a dot, such as `colors.title` to access the `title` key within the `colors` key. Read [advanced usage](./advanced.md) for examples.
Read [advanced usage](./advanced.md) for examples.
### --config-file CONFIG_FILE_PATH ### --config-file CONFIG_FILE_PATH

2
docs/reference-config-file.md
View file

@ -107,7 +107,7 @@ Current valid values are: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`,
`colorama.Fore` is used for colorization, and you can find the [docs here](https://github.com/tartley/colorama#colored-output). `colorama.Fore` is used for colorization, and you can find the [docs here](https://github.com/tartley/colorama#colored-output).
To disable colored output, set the value to `NONE`. If you set the value of any color subkey to an invalid color, no color will be used. To disable colored output, set the value to `NONE`.
### display_format ### display_format
Specifies formatter to use by default. See [formats](formats.md). Specifies formatter to use by default. See [formats](formats.md).

10
docs/usage.md
View file

@ -55,14 +55,14 @@ If you don't specify a date and time (e.g., `jrnl finished writing letter to bro
If you don't use a timestamp, `jrnl` will create an entry using the current If you don't use a timestamp, `jrnl` will create an entry using the current
time. If you use a date only (no time), `jrnl` will use the default time time. If you use a date only (no time), `jrnl` will use the default time
specified in your [configuration file](./reference-config-file.md). specified in your [configuration file](./reference-config-file.md#default_hour-and-default_minute).
Behind the scenes, `jrnl` reorganizes entries in chronological order. Behind the scenes, `jrnl` reorganizes entries in chronological order.
### Using Tags ### ### Using Tags ###
`jrnl` supports tags. The default tag symbol is `@` (largely because `#` is a `jrnl` supports tags. The default tag symbol is `@` (largely because `#` is a
reserved character). You can specify your own tag symbol in the reserved character). You can specify your own tag symbol in the
[configuration file](./reference-config-file.md). To use tags, preface the [configuration file](./reference-config-file.md#tagsymbols). To use tags, preface the
desired tag with the symbol: desired tag with the symbol:
```sh ```sh
@ -158,7 +158,7 @@ jrnl -n 5 @pinkie -and @WorldDomination
displays the last five entries containing _both_ `@pinkie` _and_ displays the last five entries containing _both_ `@pinkie` _and_
`@worldDomination`. You can change which symbols you'd like to use for tagging `@worldDomination`. You can change which symbols you'd like to use for tagging
in the [configuration file](./reference-config-file.md). in the [configuration file](./reference-config-file.md#tagsymbols).
!!! note !!! note
Entering `jrnl @pinkie @WorldDomination` will display entries in which both Entering `jrnl @pinkie @WorldDomination` will display entries in which both
@ -184,7 +184,7 @@ jrnl -starred
You can edit entries after writing them. This is particularly useful when your You can edit entries after writing them. This is particularly useful when your
journal file is encrypted. To use this feature, you need to have an external journal file is encrypted. To use this feature, you need to have an external
editor configured in your [configuration file](./reference-config-file.md). You editor configured in your [configuration file](./reference-config-file.md#editor). You
can also edit only the entries that match specific search criteria. For example, can also edit only the entries that match specific search criteria. For example,
```sh ```sh
@ -250,4 +250,4 @@ jrnl --list
``` ```
The journals displayed correspond to those specified in the `jrnl` The journals displayed correspond to those specified in the `jrnl`
[configuration file](./reference-config-file.md). [configuration file](./reference-config-file.md#journals).