/man/man1/w2html.1

  1.\" manual page for w2html, a HTML exporter for w2do
  2.\" Copyright (C) 2008 Jaromir Hradilek
  3.\"
  4.\" Permission is granted to copy, distribute and/or modify this document
  5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
  6.\" any later version published by the Free Software Foundation;  with no
  7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  8.\" 
  9.\" A copy  of the license is included  as a file called FDL  in the main
 10.\" directory of the w2do source package.
 11.\"
 12.TH W2HTML 1 "15 September 2008" "Version 2.1.0"
 13.SH NAME
 14w2html \- a HTML exporter for w2do
 15.SH SYNOPSIS
 16.B  w2html
 17.RB [ \-B | \-D ]
 18.RB [ \-H
 19.IR heading ]
 20.RB [ \-o
 21.IR file ]
 22.RB [ \-s
 23.IR file ]
 24.RB [ \-f | \-u ]
 25.RB [ \-d
 26.IR date ]
 27.br
 28.RB "       [" \-g
 29.IR group ]
 30.RB [ \-p
 31.IR priority ]
 32.RB [ \-t
 33.IR task ]
 34.br
 35.B  w2html
 36.BR  \-h " | " \-v
 37.SH DESCRIPTION
 38.B w2html
 39is a HTML exporter for w2do, a simple to use yet efficient command-line
 40todo manager written in Perl 5. All tasks are listed by default, but
 41desired subset can be easily selected via specifying options.
 42.SH OPTIONS
 43.SS General options
 44.TP
 45.BR \-h ", " \-\-help
 46Display help message and exit.
 47.TP
 48.BR \-v ", " \-\-version
 49Display version information and exit.
 50.SS Specifying options
 51.TP
 52.BI \-t " task" "\fR,\fP \-\-task" " task"
 53Specify the
 54.I task
 55name.
 56.TP
 57.BI \-g " group" "\fR,\fP \-\-group" " group"
 58Specify the
 59.I group
 60name. The group name should be a single word with maximum of 10 characters,
 61but longer names are shortened automatically.
 62.TP
 63.BI \-d " date" "\fR,\fP \-\-date" " date"
 64Specify the due
 65.IR date .
 66Available options are
 67.BR anytime ", " today ", " yesterday ", " tomorrow ", " month ", "
 68.BR year ", "
 69or an exact date in the YYYY-MM-DD format, e.g. 2008-06-17 for 17 June
 702008.
 71.TP
 72.BI \-p " priority" "\fR,\fP \-\-priority" " priority"
 73Specify the
 74.IR priority .
 75Available options are integers between
 76.BR 1 " and " 5 ,
 77where 1 represents the highest priority.
 78.TP
 79.BR \-f ", " \-\-finished
 80Specify the finished task.
 81.TP
 82.BR \-u ", " \-\-unfinished
 83Specify the unfinished task.
 84.SS Additional options
 85.TP
 86.BI \-o " file" "\fR,\fP \-\-output" " file"
 87Use selected
 88.I file
 89instead of the standard output.
 90.TP
 91.BI \-s " file" "\fR,\fP \-\-savefile" " file"
 92Use selected
 93.I file
 94instead of the default
 95.I ~/.w2do
 96as a save file.
 97.TP
 98.BI \-H " heading" "\fR,\fP \-\-heading" " heading"
 99Use selected
100.IR heading .
101.TP
102.BR \-B ", " \-\-blue
103Produce a HTML page with blue design; the default option.
104.TP
105.BR \-D ", " \-\-dark
106Produce a HTML page with dark design.
107.SH ENVIRONMENT
108.TP
109.B W2DO_SAVEFILE
110Use selected file instead of the default
111.I ~/.w2do
112as a save file.
113.SH FILES
114.TP
115.I ~/.w2do
116Default save file.
117.SH SEE ALSO
118.BR w2do (1),
119.BR w2text (1),
120.BR perl (1).
121.SH BUGS
122To report bugs please visit the appropriate section on the project
123homepage: <http://code.google.com/p/w2do/issues/>.
124.SH AUTHOR
125Written by Jaromir Hradilek <jhradilek@gmail.com>.
126.PP
127Permission is granted to copy, distribute and/or modify this document under
128the terms of the GNU Free Documentation License, Version 1.2 or any later
129version published by the Free Software Foundation; with no Invariant
130Sections, no Front-Cover Texts, and no Back-Cover Texts.
131.PP
132A copy of the license is included as a file called FDL in the main
133directory of the w2do source package.
134.SH COPYRIGHT
135Copyright (C) 2008 Jaromir Hradilek
136.PP
137This program is free software; see the source for copying conditions. It is
138distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
139without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
140PARTICULAR PURPOSE.