x
.TH ZIIT 1 "January 28, 2023"
.SH NAME
ziit \- sends and reads time logs to a ziit server.
.SH SYNOPSIS
.B ziit init
[-r reponame] [-a <address>] [-p <port>] [-o <serverpk>] [-u <userpk>] [-s <usersk>]
.B ziit add
[-r reponame] <interval> [-m <message>] [-t <tags>]
.B ziit remove
[-r reponame] <interval>
.B ziit modify
[-r reponame] [-i <interval>] [-m <message>] [-t <tags>]
.B ziit status
[-r reponame]
.B ziit list
[-r reponame] <interval>
.B ziit search
[-r reponame] <interval> <searchterm>
.B ziit summary
[-r reponame] <interval>
.SH DESCRIPTION
The ziit tool can be used to read and write time logs to a ziit server. In order
to use ziit, a ziit-rerver has to be installed and the client public key configured.
The communication between the ziit server and client is encrypted.
Normally, the ziit tool operates on the server "default". This can be changed
using the \fB-r\fR option. A server needs to be initialized using the \fBziit init\fR
command before it can be used.
Times can be added using the \fBziit add\fR command. The duration is a mandatory
parameter and has the form \fIHH:MM\fR (hours and minutes). The time however is
optional, it represents the time when this time log started. It will be set to
the current time minus the duration if not specified. The \fImessage\fR can contain
#hashtags, in order to assign it to projects and group certain times together.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help message and exit
.TP
\fB\-v\fR, \fB\-\-version\fR
Enable verbose output
.TP
\fB\-r\fR, \fB\-\-rerver\fR[=\fI\,NAME\/\fR]
Name of the server. Defaults to "default".
.SH PARAMETERS
.TP
.I
id
Is an identifier unique for each time log. Can be received through \fBziit list\fR.
.TP
.I
duration
Defines a time in the form HH:MM.
.TP
.I
message
The message associated with the time log. Can use #hashtags.
.TP
.I
interval
Specifies a time interval (from and to timestamp).
.SH EXAMPLES
Examples of how to use the program
.TP
.B
ziit list today
shows all entries from today.
.TP
.B
ziit add 15m "Work on project" -t tag1,tag2
adds a new time log, starting 15 minutes ago with a duration of 15min.
.SH FILES
.TP
.B
~/.config/ziit/client.cfg
Contains the configuration of the client and servers.
.SH SEE ALSO
Other programs related are ziit-rerver and ziit-keygen.
.SH BUGS
Please report any bugs to the author
.SH AUTHOR
Leonard Iklé <leonard.ikle@gmail.com>