diff --git a/docs/source/index.rst b/docs/source/index.rst index 31d84ac..46d7fdd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,44 +15,44 @@ Synopsys Subcommands ----------- -+-----------+-------+----------------------------------------------------------+ -| Command | Alias | Description | -+===========+=======+==========================================================+ -| archive | a | Archive entries to a hidden timesheet. | -+-----------+-------+----------------------------------------------------------+ -| backend | b | Open an sqlite shell to the database (requires having | -| | | sqlite3 installed. | -+-----------+-------+----------------------------------------------------------+ -| configure | c | Configure tiempo in-place or get path to config file. | -+-----------+-------+----------------------------------------------------------+ -| display | d | Display all entries in the current sheet. | -+-----------+-------+----------------------------------------------------------+ -| edit | e | Edit an entry. | -+-----------+-------+----------------------------------------------------------+ -| in | i | Start an entry in the current timesheet. | -+-----------+-------+----------------------------------------------------------+ -| kill | k | Delete an entry or an entire timesheet. | -+-----------+-------+----------------------------------------------------------+ -| list | l | List existing sheets. | -+-----------+-------+----------------------------------------------------------+ -| month | m | Display entries starting this month. | -+-----------+-------+----------------------------------------------------------+ -| now | n | Show all running entries. | -+-----------+-------+----------------------------------------------------------+ -| out | o | End the active entry in the current timesheet. | -+-----------+-------+----------------------------------------------------------+ -| resume | r | Restart the timer for an entry. Defaults to the last | -| | | active entry. | -+-----------+-------+----------------------------------------------------------+ -| sheet | s | Switch to a new or existing timesheet. | -+-----------+-------+----------------------------------------------------------+ -| today | t | Display entries that started today. | -+-----------+-------+----------------------------------------------------------+ -| week | w | Display entries starting last monday or later (First day | -| | | of the week configurable). | -+-----------+-------+----------------------------------------------------------+ -| yesterday | y | Display entries that started yesterday. | -+-----------+-------+----------------------------------------------------------+ +Bellow you can see the full list of subcommands. All of them can be abbreviated +to their first letter, so for example ``t backend`` can also be typed ``t b``. + ++--------------------+---------------------------------------------------------+ +| Command | Description | ++====================+=========================================================+ +| :ref:`t-archive` | Archive entries to a hidden timesheet. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-backend` | Open an sqlite shell to the database | ++--------------------+---------------------------------------------------------+ +| :ref:`t-configure` | Configure tiempo in-place or get path to config file. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-display` | Display all entries in the current sheet. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-edit` | Edit an entry. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-in` | Start an entry in the current timesheet. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-kill` | Delete an entry or an entire timesheet. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-list` | List existing sheets. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-month` | Display entries starting this month. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-now` | Show all running entries. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-out` | End the active entry in the current timesheet. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-resume` | Restart the timer for an entry. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-sheet` | Switch to a new or existing timesheet. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-today` | Display entries that started today. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-week` | Display entries starting last monday or later. | ++--------------------+---------------------------------------------------------+ +| :ref:`t-yesterday` | Display entries that started yesterday. | ++--------------------+---------------------------------------------------------+ Description ----------- @@ -137,6 +137,8 @@ hours you want to archive. ``SHEET`` Archive entries from this timesheet instead of the current one. +.. _t-backend: + t-backend ......... @@ -319,6 +321,8 @@ ago: t i --at '5 min ago' 'writing the codez' +.. _t-kill: + t-kill ...... @@ -371,6 +375,8 @@ An asterisk (*) at the left will indicate the current timesheet and a dash (-) indicates the previously used one. This is relevant for :ref:`t-sheet` where you can use - as the timesheet name to just switch to the previous one. +.. _t-month: + t-month ....... @@ -381,6 +387,8 @@ current timezone. Pass ``--month MONTH`` to display entries of different months. Just like ``t-display`` this accepts ``--grep``, ``--ids``, and ``--format``. +.. _t-now: + t-now ..... @@ -399,6 +407,8 @@ one running entry at a time this command displays its note. Just like :ref:`t-list` it displays an asterisk for the current timesheet and a dash for the previous one. +.. _t-out: + t-out ..... @@ -467,6 +477,8 @@ what timesheets you have. so you can switch quickly between the current and the previous one passing ``-`` (a dash) as the sheet name. +.. _t-today: + t-today ....... @@ -491,6 +503,8 @@ is configurable. See :ref:`settings` and :ref:`t-configure`. Just like ``t-display`` this accepts ``--grep``, ``--ids``, and ``--format``. +.. _t-yesterday: + t-yesterday ...........