| 1 | 1 | | .TH ZIIT 1 "January 28, 2023" |
| 2 | 2 | | .SH NAME |
| 3 | | - | ziit \- sends and reads time logs to a ziit server. |
| | 3 | + | ziit \- communicates with a ziit server to manage time tracking. |
| 4 | 4 | | .SH SYNOPSIS |
| 5 | 5 | | .B ziit init |
| 6 | 6 | | [-r reponame] [-a <address>] [-p <port>] [-o <serverpk>] [-u <userpk>] [-s <usersk>] |
| 7 | 7 | | |
| 8 | 8 | | .B ziit add |
| 9 | | - | [-r reponame] <interval> [-m <message>] [-t <tags>] |
| | 9 | + | [-r reponame] [-m <message>] [-t <tags>] <interval> |
| 10 | 10 | | |
| 11 | 11 | | .B ziit remove |
| 12 | 12 | | [-r reponame] <interval> |
| 13 | 13 | | |
| 14 | | - | .B ziit modify |
| 15 | | - | [-r reponame] [-i <interval>] [-m <message>] [-t <tags>] |
| 16 | | - | |
| 17 | 14 | | .B ziit status |
| 18 | 15 | | [-r reponame] |
| 19 | 16 | | |
| 20 | 17 | | .B ziit list |
| 21 | 18 | | [-r reponame] <interval> |
| 22 | | - | |
| 23 | | - | .B ziit search |
| 24 | | - | [-r reponame] <interval> <searchterm> |
| 25 | 19 | | |
| 26 | 20 | | .B ziit summary |
| 27 | | - | [-r reponame] [-f format] <interval> |
| | 21 | + | [-r reponame] [-g group] <interval> |
| 28 | 22 | | |
| 29 | 23 | | .SH DESCRIPTION |
| 30 | 24 | | The ziit tool can be used to read and write time logs to a ziit server. In order |
| 31 | | - | to use ziit, a ziit-rerver has to be installed and the client public key configured. |
| | 25 | + | to use ziit, a ziit-server has to be installed and the client public key configured. |
| 32 | 26 | | The communication between the ziit server and client is encrypted. |
| 33 | 27 | | |
| 34 | 28 | | Normally, the ziit tool operates on the server "default". This can be changed |
| 35 | | - | using the \fB-r\fR option. A server needs to be initialized using the \fBziit init\fR |
| 36 | | - | command before it can be used. |
| | 29 | + | using the \fB-r\fR option. A repository needs to be initialized using the \fBziit init\fR |
| | 30 | + | command before it can be used. Times can be added using the \fBziit add\fR command. |
| | 31 | + | The command takes an interval which specifies the time and duration of the entry. It |
| | 32 | + | also accepts an optional message and optional comma separated tags. All entries may |
| | 33 | + | be validated by the server depending on server side scripts. Removing times can be done |
| | 34 | + | using the \fBziit remove\fR command. This command also takes an interval which specifies |
| | 35 | + | the time range in which entries will be deleted. All entries that have a start time within |
| | 36 | + | that duration will be removed unless the server script disallows it. The \fBziit status\fR |
| | 37 | + | command outputs information that can be different depending on the server. The \fBziit list\fR |
| | 38 | + | command can be used to get a list of times within a certain interval. All times whose start |
| | 39 | + | time is within the interval will be output to the terminal. The \fBziit summary\fR command |
| | 40 | + | can be used to get a sum of times within a certain interval. Those times can optionally be |
| | 41 | + | grouped into sub-intervals using the \fB-g\fR option. This is the group option and it takes |
| | 42 | + | a time format as in strftime/strptime. |
| 37 | 43 | | |
| 38 | | - | Times can be added using the \fBziit add\fR command. The duration is a mandatory |
| 39 | | - | parameter and has the form \fIHH:MM\fR (hours and minutes). The time however is |
| 40 | | - | optional, it represents the time when this time log started. It will be set to |
| 41 | | - | the current time minus the duration if not specified. The \fImessage\fR can contain |
| 42 | | - | #hashtags, in order to assign it to projects and group certain times together. |
| | 44 | + | .SH OPTIONS |
| | 45 | + | Sub commands may have more options. |
| 43 | 46 | | |
| 44 | | - | .SH OPTIONS |
| 45 | 47 | | .TP |
| 46 | 48 | | \fB\-h\fR, \fB\-\-help\fR |
| 47 | 49 | | Show help message and exit |
| 48 | 50 | | .TP |
| 49 | 51 | | \fB\-v\fR, \fB\-\-version\fR |
| 50 | | - | Enable verbose output |
| | 52 | + | Output current version information. |
| | 53 | + | |
| | 54 | + | .SH INTERVAL FORMATS |
| 51 | 55 | | .TP |
| 52 | | - | \fB\-r\fR, \fB\-\-rerver\fR[=\fI\,NAME\/\fR] |
| 53 | | - | Name of the server. Defaults to "default". |
| | 56 | + | .B |
| | 57 | + | unit |
| | 58 | + | You may specify a unit in the form \fBYYYY-MM-DDTmm:ss\fR. Components from the right side can be left out. |
| | 59 | + | For instance 2024-10 will contain the whole october 2024. |
| | 60 | + | .TP |
| | 61 | + | .B |
| | 62 | + | keyword |
| | 63 | + | \fBtoday\fR which includes all of today, \fByesterday\fR which includes all of yesterday, \fBtomorrow\fR which includes |
| | 64 | + | all of tomorrow, \fBweek\fR which includes the whole current week, \fBmonth\fR which includes all of the current month |
| | 65 | + | and \fByear\fR which includes all of the current year. |
| | 66 | + | .TP |
| | 67 | + | .B |
| | 68 | + | range |
| | 69 | + | Specify two ranges separated with a comma, for instance 2024-10-03T10:00,2024-11-03T11:00 includes everything between |
| | 70 | + | the two specified times. You can also leave out components from the right: 2024-10-03,2024-10-04 will include everything |
| | 71 | + | between the two days. |
| | 72 | + | .TP |
| | 73 | + | .B |
| | 74 | + | duration |
| | 75 | + | Specify a duration with an optional timestamp. For instance, \fB2h\fR will include everything from two hours ago until |
| | 76 | + | now. Multiple components can be concatenated, for example \fB2h3m10s\fR. You can use \fBh\fR (hours), \fBm\fR (minutes) |
| | 77 | + | and \fBs\fR (seconds). The duration can be followed by a timestamp. For example \fB2h@2025-03-02T10:00\fR starts at |
| | 78 | + | 2025-03-02T10:00 and lasts two hours. Another example would be \fB30m@now\fR which means from now until in two hours. |
| | 79 | + | It's also possible to use UTC using a Z suffix: 2025-03-02T10:00Z will use the UTC timezone rather than the users local |
| | 80 | + | time. |
| 54 | 81 | | |
| 55 | | - | .SH PARAMETERS |
| | 82 | + | .SH INTERVAL EXAMPLES |
| | 83 | + | Examples of supported intervals. |
| | 84 | + | .TP |
| | 85 | + | .B |
| | 86 | + | today |
| | 87 | + | Includes the whole current day. |
| 56 | 88 | | .TP |
| 57 | | - | .I |
| 58 | | - | id |
| 59 | | - | Is an identifier unique for each time log. Can be received through \fBziit list\fR. |
| | 89 | + | .B |
| | 90 | + | month |
| | 91 | + | Includes the whole current month. |
| 60 | 92 | | .TP |
| 61 | | - | .I |
| 62 | | - | duration |
| 63 | | - | Defines a time in the form HH:MM. |
| | 93 | + | .B |
| | 94 | + | 2024 |
| | 95 | + | Includes the whole year 2024. |
| 64 | 96 | | .TP |
| 65 | | - | .I |
| 66 | | - | message |
| 67 | | - | The message associated with the time log. Can use #hashtags. |
| | 97 | + | .B |
| | 98 | + | 2024,2026 |
| | 99 | + | Includes the years 2024, 2025 and 2026. |
| 68 | 100 | | .TP |
| 69 | | - | .I |
| 70 | | - | interval |
| 71 | | - | Specifies a time interval (from and to timestamp). |
| 72 | | - | .SH EXAMPLES |
| | 101 | + | .B |
| | 102 | + | 2024-03-10,2024-03-15 |
| | 103 | + | Includes all days within and including 2024-03-10 and 2024-03-15. |
| | 104 | + | .TP |
| | 105 | + | .B |
| | 106 | + | 5m |
| | 107 | + | Includes 5 minutes ago until now. |
| | 108 | + | .TP |
| | 109 | + | .B |
| | 110 | + | 2h30m10s |
| | 111 | + | Includes 2 hours, 30 minutes and 10 seconds ago until now. |
| | 112 | + | .TP |
| | 113 | + | .B |
| | 114 | + | 5m@2024-10-09T10:00 |
| | 115 | + | Starts at 2024-10-09T10:00 and ends at 2024-10-09T10:05. |
| | 116 | + | .TP |
| | 117 | + | .B |
| | 118 | + | 5m |
| | 119 | + | Starts 5 minutes ago and ends now. |
| | 120 | + | .TP |
| | 121 | + | .B |
| | 122 | + | 5m@now |
| | 123 | + | Starts now and ends in 5 minutes. |
| | 124 | + | |
| | 125 | + | .SH USAGE EXAMPLES |
| 73 | 126 | | Examples of how to use the program |
| 74 | 127 | | .TP |
| 75 | 128 | | .B |
| 76 | | - | ziit list today |
| 77 | | - | shows all entries from today. |
| | 129 | + | ziit -r home init |
| | 130 | + | initializes the "home" repository interactively. |
| 78 | 131 | | .TP |
| 79 | 132 | | .B |
| 80 | | - | ziit add 15m "Work on project" -t tag1,tag2 |
| | 133 | + | ziit -r home list today |
| | 134 | + | shows all entries from today from the repository "home". |
| | 135 | + | .TP |
| | 136 | + | .B |
| | 137 | + | ziit remove today |
| | 138 | + | removes all entries from today in the "default" repository. |
| | 139 | + | .TP |
| | 140 | + | .B |
| | 141 | + | ziit add 15m -m "Work on project" -t tag1,tag2 |
| 81 | 142 | | adds a new time log, starting 15 minutes ago with a duration of 15min. |
| | 143 | + | .TP |
| | 144 | + | .B |
| | 145 | + | ziit summary year -g "%Y-%m" |
| | 146 | + | outputs a summary of all entries within the current year grouped by month. |
| 82 | 147 | | .SH FILES |
| 83 | 148 | | .TP |
| 84 | 149 | | .B |
| 85 | 150 | | ~/.config/ziit/client.cfg |
| 86 | 151 | | Contains the configuration of the client and servers. |
| 87 | 152 | | .SH SEE ALSO |
| 88 | | - | Other programs related are ziit-rerver and ziit-keygen. |
| | 153 | + | Other programs related are ziit-server and ziit-keygen. |
| 89 | 154 | | .SH BUGS |
| 90 | 155 | | Please report any bugs to the author |
| 91 | | - | .SH AUTHOR |
| 92 | | - | Leonard Iklé <leonard.ikle@gmail.com> |
| 93 | 156 | | |
