~mjasnik/timekpr-revived/stable

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
.\" Man page generated from reStructuredText.
.
.TH TIMEKPR.CONF 5 "2014-09-24" "0.3.7" "File Formats Manual"
.SH NAME
timekpr.conf \- configuration file for timekpr.
.
.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
..
.\" Manual page for timekpr daemon written in rst.
.
.\" Can be converted using rst2man, which in trusty is in the package "python-docutils"
.
.\" 
.
.\" rst Reference: http://docutils.sf.net/docs/user/rst/quickref.html
.
.\" 
.
.\" man-pages can have these parts:
.
.\" NAME
.
.\" SYNOPSIS
.
.\" CONFIGURATION         [Normally only in Section 4]
.
.\" DESCRIPTION
.
.\" OPTIONS.. [Normally only in Sections 1, 8]
.
.\" EXIT STATUS          [Normally only in Sections 1, 8]
.
.\" RETURN VALUE  [Normally only in Sections 2, 3]
.
.\" ERRORS.. [Typically only in Sections 2, 3]
.
.\" ENVIRONMENT
.
.\" FILES
.
.\" VERSIONS              [Normally only in Sections 2, 3]
.
.\" CONFORMING TO
.
.\" NOTES
.
.\" BUGS
.
.\" EXAMPLE
.
.\" SEE ALSO
.
.SH DESCRIPTION
.sp
The file \fI/etc/timekpr.conf\fP contains defaults for \fBtimekpr(8)\fP and the associated programs.
The file consists of multiple sections.
Each line holds a single value pair in the form \fIoption\fP = \fIvalue\fP\&.
Double or single quotes are allowed around the value, as is whitespace around the equals sign. Comment lines must have a hash sign (#) in the first column.
.sp
The valid sections and configuration options are:
.SS SECTION [general]
.INDENT 0.0
.TP
.B VERSION
The version of this config file.
.UNINDENT
.SS SECTION [variables]
.INDENT 0.0
.TP
.B GRACEPERIOD
The grace period, where a notification pops up letting the users know that
their time usage will be over soon. By default users are given 120 seconds to
finish up their work (in seconds, e.g. 120 means 2 minutes).
Default value "120".
.TP
.B POLLTIME
How often should the timelogs be checked (in seconds).
Default value "30".
.TP
.B DEBUGME
\fITrue\fP keeps a logfile, \fIFalse\fP does not.
Default value "True".
.TP
.B LOCKLASTS
Default lock period, can be \fIday(s)\fP, \fIhour(s)\fP, \fIminute(s)\fP, \fImonth(s)\fP\&.
Default value "30 minutes".
.UNINDENT
.SS SECTION [directories]
.INDENT 0.0
.TP
.B TIMEKPRDIR
Default directory for per\-user configuration and \fI\&.lock\fP files.
Default value "/etc/timekpr".
.TP
.B TIMEKPRWORK
Default working directory for \fI\&.time\fP, \fI\&.logout\fP, and \fI\&.late\fP files.
Default value "/var/lib/timekpr".
.TP
.B TIMEKPRSHARED
Default directory for shared files (e.g. images and gui definitions).
Default value "/usr/share/timekpr".
.TP
.B LOGFILE
Location of the logfile.
Default value "/var/log/timekpr.log".
.UNINDENT
.SS SECTION [speech]
.INDENT 0.0
.TP
.B COMMAND
The command to execute for speech output.
The following patterns will be substituted before executing the command:
.INDENT 7.0
.IP \(bu 2
\fI{language}\fP the current locale setting (e.g. \(aqde\(aq)
.IP \(bu 2
\fI{message}\fP the message text
.UNINDENT
.sp
Default value "espeak \-v{language} {message}".
.UNINDENT
.SH FILES
.sp
\fI/etc/timekpr.conf\fP
.SH AUTHORS
.sp
Chris Jackson wrote the original bash script.
.sp
Even Nedberg, Savvas Radevic, and Frank Gerbig wrote the current python implementation.
.sp
Nicolas Iselin, Savvas Radevic, and Frank Gerbig wrote the manpages.
.SH SEE ALSO
.sp
\fBtimekpr(8)\fP, \fBtimekpr.conf(5)\fP, \fBtimekpr\-gui(8)\fP, \fBtimekpr\-gui3(8)\fP, \fBtimekpr\-client(8)\fP, The \fBLinux\-PAM guide for system administrators\fP (modules \fBaccess\fP and \fBlimits\fP).
.SH COPYRIGHT
timekpr is licensed under the GNU GPLv3, the documentation is licensed under the GNU Free Documentation License.
.\" Generated by docutils manpage writer.
.