.\" Man page generated from reStructuredText.
.
.TH GTIMELOGRC 5 "2013-12-23" "0.9.1" ""
.SH NAME
gtimelogrc \- gtimelog configuration file
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
This is the configuration file for \fBgtimelog\fP(1).  It is a pretty standard
INI file as recognized by Python\(aqs ConfigParser, which means:
.INDENT 0.0
.IP \(bu 2
it consists of sections, led by a \fB[name]\fP header
.IP \(bu 2
values are specified as \fBname = value\fP (or \fBname: value\fP)
.IP \(bu 2
values can be continued across multiple lines if continuation lines
start with whitespace
.IP \(bu 2
comments are lines starting with \fB#\fP or \fB;\fP
.IP \(bu 2
if the same value appears multiple times, new appearances override old ones
.UNINDENT
.sp
Only one section is important to gtimelog: \fB[gtimelog]\fP\&.  Within it you can
specify the following settings:
.INDENT 0.0
.TP
.B list\-email
recipient address for activity reports
.sp
Example: \fBname = activity\-reports@example.com\fP
.TP
.B name
your name as it should appear in the reports
.sp
Example: \fBname = Marius\fP
.TP
.B mailer
command to launch your email client.
.sp
If \fB%s\fP appears in the command, it will be replaced by the filename of
the draft of the email.  If \fB%s\fP doesn\(aqt appear, it will be added to the
end of the command.
.sp
Example: \fBmailer = gedit\fP will just open the report in GEdit,
useful if you don\(aqt want to send it to anyone.
.sp
Example: \fBmailer = x\-terminal\-emulator \-e mutt \-H %s\fP (which is the
default setting) will open Mutt with the draft in a terminal.
\fBx\-terminal\-emulator\fP is a Debianism.
.sp
Example: \fBmailer = S=\(aq%s\(aq; thunderbird \-compose "to=\(aq$(cat $S|head \-1|sed \-e "s/^To: //")\(aq,subject=\(aq$(cat $S|head \-2|tail \-1|sed \-e "s/^Subject: //")\(aq,body=\(aq$(cat $S|tail \-n +4)\(aq"\fP
will open Thunderbird with the draft.
.TP
.B editor
text editor to be used for editing timelog.txt
.sp
If \fB%s\fP appears in the command, it will be replaced by the filename of
the timelog.txt file.  If \fB%s\fP doesn\(aqt appear, it will be added to the
end of the command.
.sp
Example: \fBeditor = xdg\-open\fP (the default value) opens whichever
program is associated with .txt files on your system.
.TP
.B spreasheet
program used to display CSV reports
.sp
If \fB%s\fP appears in the command, it will be replaced by the filename of
the CSV report.  If \fB%s\fP doesn\(aqt appear, it will be added to the end of
the command.
.sp
Example: \fBspreadsheet = xdg\-open\fP (the default value) opens whichever
program is associated with .csv files on your system.
.TP
.B chronological, summary_view
select the initial detail level
.sp
GTimeLog can show you one of three detail levels:
.INDENT 7.0
.IP \(bu 2
chronological (Alt+1) shows all the entries in order
.IP \(bu 2
grouped (Alt+2) shows only work entries, grouped by title
.IP \(bu 2
summary (Alt+3) shows only categories of work entries, grouped
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# start in chronological view
chronological = True
summary_view = False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# start in grouped view
chronological = False
summary_view = False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# start in summary view
summary_view = True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B show_tasks
should the task pane be shown on startup?
.sp
Example: \fBshow_tasks = True\fP
.TP
.B enable_gtk_completion
should the input box show an autocompletion popup?
.sp
If set to \fBTrue\fP, the Up and Down keys navigate the completion popup
menu.
.sp
If set to \fBFalse\fP, the Up and Down keys trigger prefix\-completion in the
input box.
.sp
Note that PageUp and PageDown keys always trigger prefix\-completion, so
there\(aqs no good reason to ever disable this option.
.sp
Example: \fBenable_gtk_completion = True\fP
.TP
.B hours
goal for the number of hours of work in a day
.sp
This is used to display the "Time left at work" estimate.
.sp
Example: \fBhours = 4\fP
.TP
.B virtual_midnight
hour in the morning when it\(aqs safe to assume you\(aqre not staying up working
any more.
.sp
Any work done between midnight and "virtual midnight" will be attributed
to the previous calendar day.
.sp
Example: \fBvirtual_midnight = 2:00\fP (the default setting)
.sp
Warning: changing this setting may mean that old reports can no longer be
correctly reconstructed from timelog.txt
.TP
.B task_list_url
URL for downloading the task list
.sp
If not set, tasks will be read from a local file (tasks.txt in the gtimelog
data directory)
.sp
If set, tasks will be loaded from the specified URL (but only when you
right\-click and explicitly ask for a refresh).  GTimeLog expects a
text/plain response with a list of tasks, one per line.  At the time of
this writing GTimeLog doesn\(aqt show HTTP authentication prompts, so if you
need auth, you need to put your username and password into the URL.
.sp
This feature is mostly useless.
.sp
Example: \fBtask_list_url =\fP (the default setting)
.sp
Example: \fBtask_list_url = https://wiki.example.com/Project/Tasks/raw\fP
.TP
.B edit_tasklist_cmd
command for editing the task list
.sp
Example: \fBedit_tasklist_cmd =\fP (the default setting)  means that the
"Edit task list" command in the popup menu will be disabled.
.sp
Example: \fBedit_tasklist_cmd = xdg\-open ~/.local/share/gtimelog/tasks.txt\fP
.sp
Example: \fBedit_tasklist_cmd = xdg\-open https://wiki.example.com/Project/Tasks/edit\fP
.sp
Bug: this command should support \fB%s\fP for specifying the full tasks.txt
pathname, but it doesn\(aqt.
.TP
.B show_office_hours
whether to show "At office today: NN hours, NN minutes" in the main window
.sp
Example: \fBshow_office_hours = True\fP
.TP
.B show_tray_icon
whether to show a notification icon
.sp
Example: \fBshow_tray_icon = True\fP
.TP
.B prefer_app_indicator, prefer_old_tray_icon
what kind of tray icon do you prefer?
.sp
GTimeLog supports three kinds:
.INDENT 7.0
.IP \(bu 2
Unity application indicator
.IP \(bu 2
a standard Gtk+ status icon
.IP \(bu 2
ancient EggTrayIcon that shows a ticking clock next to the icon
.UNINDENT
.sp
Support for each is conditional on the availability of installed libraries.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# prefer Unity application indicators, then fall back to the Gtk+
# status icon, then fall back to EggTrayIcon.
prefer_app_indicator = True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# prefer the ancient EggTrayIcon, then fall back to the Gtk+
# status icon, then fall back to Unity app indicator.
prefer_app_indicator = False
prefer_old_tray_icon = True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# prefer the Gtk+ status icon, then fall back to the ancient
# EggTrayIcon, then fall back to Unity app indicator.
prefer_app_indicator = False
prefer_old_tray_icon = False
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B start_in_tray
whether GTimeLog should start minimized
.sp
This can also be achieved by running \fBgtimelog \-\-tray\fP, so the option is
of little use.
.sp
This option is ignored if GTimeLog is not using a tray icon (because
\fBshow_tray_icon\fP is set to \fBFalse\fP, or if you\(aqre missing all the
libraries).
.sp
Example:: \fBstart_in_tray = False\fP
.TP
.B report_style
choose one of the available report styles for weekly and monthly reports
.sp
Example:: \fBreport_style = plain\fP (the default)
.sp
The report looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cat1: entry1                              N h N min
cat1: entry2                              N h N min
cat2: entry1                              N h N min

Total work done this week: N hours N min

By category:

cat1: N hours N min
cat2: N hours N min
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:: \fBreport_style = categorized\fP
.sp
The report looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
category 1:
  entry1                                      MM
  entry2                                   HH:MM
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
                                           HH:MM
category 2:
  entry1                                      MM
  entry2                                   HH:MM
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
                                           HH:MM

Total work done this week: HH:MM

Categories by time spent:

category 1       HH:MM
category 2       HH:MM
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXAMPLE
.sp
Example of \fB~/.config/gtimelog/gtimelogrc\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[gtimelog]

# Be sure to change these if you want to email the reports somewhere
name = Anonymous
list\-email = activity@example.com

# Don\(aqt want email?  Just look at reports in a text editor
mailer = gedit %s

# Set a goal for 7 hours and 30 minutes of work per day
hours = 7.5

# I\(aqll never stay up working this late
virtual_midnight = 06:00

# Disable the tray icon
show_tray_icon = no

# Hide the Tasks pane on startup
show_tasks = no
.ft P
.fi
.UNINDENT
.UNINDENT
.SH BUGS
.sp
The config file should not be necessary.  GTimeLog should figure out the
right programs by looking at your desktop preferences; it should remember
the view options from a previous invocation; and it should have a GUI way
for specifying things such as your name or the report mailing list.
.SH FILES
.nf
\fB~/.gtimelog/gtimelogrc\fP
\fB~/.config/gtimelog/gtimelogrc\fP
.fi
.sp
.INDENT 0.0
.INDENT 3.5
Configuration file.
.sp
GTimeLog determines the location for the config file as follows:
.INDENT 0.0
.IP 1. 3
If the environment variable \fBGTIMELOG_HOME\fP is set, use
\fB$GTIMELOG_HOME/gtimelogrc\fP\&.
.IP 2. 3
If \fB~/.gtimelog/\fP exists, use \fB~/.gtimelog/gtimelogrc\fP\&.
.IP 3. 3
If the environment variable \fBXDG_CONFIG_HOME\fP is set, use
\fB$XDG_CONFIG_HOME/gtimelog/gtimelogrc\fP\&.
.IP 4. 3
Use \fB~/.config/gtimelog/gtimelogrc\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBgtimelog\fP(1)
.SH AUTHOR
Marius Gedminas <mgedmin@gedmin.as>
.SH COPYRIGHT
Marius Gedminas
.\" Generated by docutils manpage writer.
.