more docs

This commit is contained in:
Abraham Toriz 2022-09-25 23:35:09 -04:00
parent 5f7fc63ef4
commit 7115ddfe54
No known key found for this signature in database
GPG Key ID: D5B4A746DB5DD42A
1 changed files with 90 additions and 19 deletions

View File

@ -137,6 +137,8 @@ t-backend
Open a sqlite3 shell into the database. Sqlite3 must be installed and in the
``PATH`` variable for this command to work.
.. _t-configure:
t-configure
...........
@ -241,20 +243,75 @@ the start time of the entry.
The sheet to display. Pass 'all' to see entries from all sheets or 'full' to
see hidden entries.
edit
t-edit
......
``t e|edit [OPTIONS] [NOTE]``
If run without arguments this command will launch a text editor with the text of
the current timesheet's last entry's note. Upon saving and exiting the new text
will be set. If a string is given as command-line argument it will be used as
the new note and no editor will be launched. If used with ``--append`` the
new text will be appended to the previous one using whatever string is set as
:ref:`append_notes_delimiter` in the settings file.
The last entry is defined as the one that was started last, not necessarily the
one with the highest ID in the current timesheet.
You can also leave the note untouched and edit other parts of the entry like its
start and end times using ``--start`` and ``--end`` respectively, see
:ref:`specifying-times`. Or you can move an entry that was created in the wrong
timesheet by using ``--move``.
**Options**
-z, --append
Append the new text to the current note instead of replacing it.
-e, --end <TIME>
Set this as the end time.
--id <ID>
Edit entry with this ID instead of the last one in the current sheet.
-m, --move <SHEET>
Move entry to another sheet.
-s, --start <TIME>
Set this as the start time.
``<NOTE>``
Set this as the entry's note. It will replace the previous one unless
``--append`` is given.
t-help
......
``t help SUBCOMMAND``
Get help on the specified subcommand. It is equivalent to passing ``-h`` to any
subcommand.
t-in
....
help
....
``t i|in [--at TIME] [NOTE]``
in
..
Start an entry in the current timesheet. If used without arguments and
:ref:`require_note` is set to ``true`` in the settings then it will launch a
text editor for you to write a note. Pass ``--at`` to set a specific time of
start instead of now, like in case you forgot to start an activity five minutes
ago:
kill
....
.. code:: shell-session
list
....
t i --at '5 min ago' 'writing the codez'
t-kill
......
t-list
......
t-month
.......
@ -266,18 +323,18 @@ current timezone. Pass ``--month MONTH`` to display entries of different months.
Just like ``t-display`` this accepts ``--grep``, ``--ids``, and ``--format``.
now
...
out
...
resume
......
sheet
t-now
.....
t-out
.....
t-resume
........
t-sheet
.......
t-today
.......
@ -310,6 +367,8 @@ computer's current timezone.
Just like ``t-display`` this accepts ``--grep``, ``--ids``, and ``--format``.
.. _settings:
Settings
--------
@ -317,6 +376,16 @@ Settings
describe the settings file
.. _append_notes_delimiter:
append_notes_delimiter
......................
.. _require_note:
require_note
............
Per command default formatters
..............................
@ -359,6 +428,8 @@ Files and paths
explain the config file, and database path
.. _specifying-times:
Specifying times
----------------