mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Docs: Added bare-bones man pages
This commit is contained in:
parent
1d32b6fd42
commit
f550e8a1a7
6 changed files with 157 additions and 1 deletions
10
doc/CMakeLists.txt
Normal file
10
doc/CMakeLists.txt
Normal file
|
@ -0,0 +1,10 @@
|
|||
cmake_minimum_required (VERSION 2.8)
|
||||
|
||||
message ("-- Configuring man pages")
|
||||
|
||||
configure_file (man/timew.1.in man/timew.1)
|
||||
configure_file (man/timewrc.5.in man/timewrc.5)
|
||||
|
||||
install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/man/ DESTINATION ${TIMEW_MAN1DIR} FILES_MATCHING PATTERN "*.1")
|
||||
install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/man/ DESTINATION ${TIMEW_MAN5DIR} FILES_MATCHING PATTERN "*.5")
|
||||
|
1
doc/man/.gitignore
vendored
Normal file
1
doc/man/.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
*.[0-9]
|
66
doc/man/timew.1.in
Normal file
66
doc/man/timew.1.in
Normal file
|
@ -0,0 +1,66 @@
|
|||
.TH timew 1 2015-11-29 "${PACKAGE_STRING}" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
timew \- A command line time tracker.
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B timew <command>
|
||||
|
||||
.SH DESCRIPTION
|
||||
Timewarrior is a command line time tracker. It allows you to very easily track
|
||||
your time spent on projects, and generate summary reports.
|
||||
|
||||
.SH SUBCOMMANDS
|
||||
|
||||
Timewarrior supports many commands.
|
||||
|
||||
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
||||
Timewarrior stores its configuration in a file in the user's home directory:
|
||||
~/.timewrc.
|
||||
|
||||
.SH MORE EXAMPLES
|
||||
|
||||
For examples please see the online documentation starting at:
|
||||
|
||||
.RS
|
||||
<http://taskwarrior.org/???>
|
||||
.RE
|
||||
|
||||
Note that the online documentation can be more detailed and more current than
|
||||
this man page.
|
||||
|
||||
.SH FILES
|
||||
|
||||
.TP
|
||||
~/.timewrc
|
||||
User configuration file - see also timewrc(5). Note that this can be
|
||||
overridden on the command line or by the TIMEWRC environment variable.
|
||||
|
||||
.SH "CREDITS & COPYRIGHTS"
|
||||
Copyright (C) 2015 \- 2016 P. Beckingham, F. Hernandez.
|
||||
|
||||
Timewarrior is distributed under the MIT license. See
|
||||
http://www.opensource.org/licenses/mit-license.php for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR timewrc(5)
|
||||
|
||||
For more information regarding Timewarrior, see the following:
|
||||
|
||||
.TP
|
||||
The official site at
|
||||
<http://taskwarrior.org>
|
||||
|
||||
.TP
|
||||
The official code repository at
|
||||
<https://git.tasktools.org/scm/tm/timew.git>
|
||||
|
||||
.TP
|
||||
You can contact the project by emailing
|
||||
<support@taskwarrior.org>
|
||||
|
||||
.SH REPORTING BUGS
|
||||
.TP
|
||||
Bugs in Timewarrior may be reported to the issue-tracker at
|
||||
<https://bug.tasktools.org/>
|
||||
|
78
doc/man/timewrc.5.in
Normal file
78
doc/man/timewrc.5.in
Normal file
|
@ -0,0 +1,78 @@
|
|||
.TH timew 5 2015-11-29 "${PACKAGE_STRING}" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
timewrc \- Configuration details for the timew(1) command
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B $HOME/.timewrc
|
||||
.br
|
||||
.B TIMEWRC=<directory-path>/.timewrc timew ...
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B Timewarrior
|
||||
obtains its configuration data from a file called
|
||||
.I .timewrc
|
||||
\&. This file is normally located in the user's home directory:
|
||||
|
||||
.RS
|
||||
$HOME/.timewrc
|
||||
.RE
|
||||
|
||||
...
|
||||
|
||||
.SH EDITING
|
||||
|
||||
.SH NESTING CONFIGURATION FILES
|
||||
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
|
||||
.SH CONFIGURATION VARIABLES
|
||||
Valid variable names and their default values are:
|
||||
|
||||
.SS FILES
|
||||
|
||||
.SS MISCELLANEOUS
|
||||
|
||||
.TP
|
||||
.TP
|
||||
.B name=value
|
||||
...
|
||||
|
||||
.SS DATES
|
||||
|
||||
.SS HOLIDAYS
|
||||
|
||||
.SS DEFAULTS
|
||||
|
||||
.SS REPORTS
|
||||
|
||||
.SH "CREDITS & COPYRIGHTS"
|
||||
Copyright (C) 2006 \- 2016 P. Beckingham, F. Hernandez.
|
||||
|
||||
This man page was originally written by Federico Hernandez.
|
||||
|
||||
Timewarrior is distributed under the MIT license. See
|
||||
http://www.opensource.org/licenses/mit-license.php for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR timew(1)
|
||||
|
||||
For more information regarding Timewarrior, see the following:
|
||||
|
||||
.TP
|
||||
The official site at
|
||||
<http://taskwarrior.org/???>
|
||||
|
||||
.TP
|
||||
The official code repository at
|
||||
<https://git.tasktools.org/scm/tm/timew.git>
|
||||
|
||||
.TP
|
||||
You can contact the project by emailing
|
||||
<support@taskwarrior.org>
|
||||
|
||||
.SH REPORTING BUGS
|
||||
.TP
|
||||
Bugs in Taskwarrior may be reported to the issue-tracker at
|
||||
<https://bug.tasktools.org/>
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue