fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-06-28 13:36:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Finished docs

Browse source
This commit is contained in:
Manuel Ebert 2013-11-03 20:31:24 -08:00
parent 588229581b
commit ddf2eda194
4 changed files with 69 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

70
docs/usage.rst
View file

@ -3,7 +3,48 @@
Basic Usage
===========
*jrnl* has two modes: **composing** and **viewing**.
*jrnl* has two modes: **composing** and **viewing**. Basically, whenever you `don't` supply any arguments that start with a dash or double-dash, you're in composing mode, meaning you can write your entry on the command line or an editor of your choice.
We intentionally break a convention on command line arguments: all arguments starting with a `single dash` will `filter` your journal before viewing it, and can be combined arbitrarily. Arguments with a `double dash` will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).
Composing Entries
-----------------
Composing mode is entered by either starting ``jrnl`` without any arguments -- which will prompt you to write an entry or launch your editor -- or by just writing an entry on the prompt, such as::
jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
Smart timestamps
~~~~~~~~~~~~~~~~
Timestamps that work:
* at 6am
* yesterday
* last monday
* sunday at noon
* 2 march 2012
* 7 apr
* 5/20/1998 at 23:42
Starring entries
~~~~~~~~~~~~~~~~
To mark an entry as a favourite, simply "star" it::
jrnl last sunday *: Best day of my life.
If you don't want to add a date (ie. your entry will be dated as now), The following options are equivalent:
* ``jrnl *: Best day of my life.``
* ``jrnl *Best day of my life.``
* ``jrnl Best day of my life.*``
.. note::
Just make sure that the asterisk sign is **not** surrounded by whitespaces, e.g. ``jrnl Best day of my life! *`` will **not** work (the reason being that the ``*`` sign has a special meaning on most shells).
Viewing
-------
@ -14,11 +55,11 @@ Viewing
will list you the ten latest entries, ::
jrnl -from "last year" -to march
jrnl -from "last year" -until march
everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use ::
everything that happened from the start of last year to the start of last march. To only see your favourite entries, use ::
jrnl -short
jrnl -starred
Using Tags
----------
@ -41,24 +82,3 @@ the last five entries containing both ``@pineapple`` **and** ``@lubricant``. You
``jrnl @pinkie @WorldDomination`` will switch to viewing mode because although _no_ command line arguments are given, all the input strings look like tags - *jrnl* will assume you want to filter by tag.
Composing
---------
Composing mode is entered by either starting ``jrnl`` without any arguments -- which will prompt you to write an entry or launch your editor -- or by just writing an entry on the prompt, such as::
jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
Smart timestamps
~~~~~~~~~~~~~~~~
Timestamps that work:
* at 6am
* yesterday
* last monday
* sunday at noon
* 2 march 2012
* 7 apr
* 5/20/1998 at 23:42