diff options
author | Micah Jerome Ellison <micah.jerome.ellison@gmail.com> | 2020-10-24 15:41:58 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-24 15:41:58 -0700 |
commit | 5b029e61174bd73ef5c4ac55e4a8ab40180627d4 (patch) | |
tree | 9701d593dfb9e56bb4a755bb32d1c62ec55f4ba8 /docs/usage.md | |
parent | 4ee4f388f4127efb1c2d219b4c87e07d5c56f8da (diff) |
Documentation updates (#1032)
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
Clean up encryption docs
Clean up security docs
Delete export.md
Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
Update mkdocs config for new files
* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
This reverts commit 13b4266ed1e7150ef5a2235a2f816333692b71f2.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* Doc updates:
- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review
Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
Diffstat (limited to 'docs/usage.md')
-rw-r--r-- | docs/usage.md | 56 |
1 files changed, 36 insertions, 20 deletions
diff --git a/docs/usage.md b/docs/usage.md index d56c9418..df683b0d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -11,6 +11,8 @@ it. Filter arguments can be combined arbitrarily. Arguments with a _double dash_ arguments are mutually exclusive (i.e., you can only specify one way to display or export your journal at a time). +For a list of commands, enter `jrnl --help`. + ## Composing Entries ## Composing mode is entered by either starting `jrnl` without any arguments -- @@ -56,10 +58,9 @@ Behind the scenes, `jrnl` reorganizes entries in chronological order. ### Using Tags ### -`jrnl` supports tags. Note that because `#` is a reserved character, the default -tag symbol is `@`. You can specify your own tag symbol in the configuration -file. There is no limit to how many tags you can use in an entry. To use tags, -simply preface the desired tag with the symbol: +`jrnl` supports tags. The default tag symbol is `@` (largely because `#` is a +reserved character). You can specify your own tag symbol in the configuration +file. To use tags, preface the desired tag with the symbol: ```sh jrnl Had a wonderful day at the @beach with @Tom and @Anna. @@ -68,6 +69,8 @@ jrnl Had a wonderful day at the @beach with @Tom and @Anna. Although you can use capitals while tagging an entry, searches by tag are case-insensitive. +There is no limit to how many tags you can use in an entry. + ### Starring Entries ### To mark an entry as a favorite, simply "star" it using an asterisk (`*`): @@ -83,20 +86,22 @@ _now_), the following options are equivalent: - `jrnl *Best day of my life.` - `jrnl Best day of my life.*` -!!! note Make sure that the asterisk (`*`) is **not** surrounded by whitespaces. -`jrnl Best day of my life! *` will not work because the `*` character has a -special meaning in most shells. +!!! note + Make sure that the asterisk (`*`) is **not** surrounded by whitespaces. + `jrnl Best day of my life! *` will not work because the `*` character has a + special meaning in most shells. -## Viewing Entries ## +## Viewing and Searching Entries ## -`jrnl` can display entries in a variety of ways. Entries are filtered using commands preceded by a single dash (`-`). Type `jrnl -h` for a list of -commands. +`jrnl` can display entries in a variety of ways. -It is possible to see all entries by entering `jrnl -until today`. However, in -most cases you will likely want to use a filter to see specific entries that -meet certain criteria. `jrnl` provides several filtering commands, prefaced by a -single dash (`-`), that allow you to find exactly what you're looking for. For -example, +To view all entries, enter: +```sh +jrnl -to today +``` + +`jrnl` provides several filtering commands, prefaced by a single dash (`-`), that +allow you to find a more specific range of entries. For example, ```sh jrnl -n 10 @@ -107,15 +112,20 @@ same way. If you want to see all of the entries you wrote from the beginning of last year until the end of this past March, you would enter ```sh -jrnl -from "last year" -until march +jrnl -from "last year" -to march ``` Filter criteria that use more than one word require surrounding quotes (`""`). +To see entries on a particular date, use `-on`: +```sh +jrnl -on yesterday +``` + ### Text Search ### -The `-contains` command displays all entries containing a specific string. This -may be helpful when you're searching for entries and you can't remember if you +The `-contains` command displays all entries containing the text you enter after it. +This may be helpful when you're searching for entries and you can't remember if you tagged any words when you wrote them. You may realize that you use a word a lot and want to turn it into a tag in all @@ -153,6 +163,12 @@ in the configuration. of the input strings look like tags. `jrnl` will assume you want to filter by tag, rather than create a new entry that consists only of tags. +To view a list of all tags in the journal, enter: + +```sh +jrnl --tags +``` + ### Viewing Starred Entries ### To display only your favorite (starred) entries, enter @@ -169,7 +185,7 @@ editor configured in your configuration file. You can also edit only the entries that match specific search criteria. For example, ```sh -jrnl -until 1950 @texas -and @history --edit +jrnl -to 1950 @texas -and @history --edit ``` opens your external editor displaying all entries tagged with `@texas` and @@ -227,7 +243,7 @@ removed from the journal. To list all of your journals: ```sh -jrnl -ls +jrnl --list ``` The journals displayed correspond to those specified in the `jrnl` configuration |