.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "W2HTML 1" .TH W2HTML 1 "2010-02-13" "Version 2.3.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" w2html \- a HTML exporter for w2do .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBw2html\fR [\fB\-bikDIPS\fR] [\fB\-H\fR \fIheading\fR] [\fB\-e\fR \fIencoding\fR] [\fB\-o\fR \&\fIfile\fR] [\fB\-s\fR \fIfile\fR] [\fB\-f\fR|\fB\-u\fR] [\fB\-d\fR \fIdate\fR] [\fB\-g\fR \fIgroup\fR] [\fB\-p\fR \fIpriority\fR] [\fB\-t\fR \fItask\fR] .PP \&\fBw2html\fR \fB\-h\fR | \fB\-v\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBw2html\fR is a \s-1HTML\s0 exporter for w2do, a simple to use yet efficient command-line todo manager written in Perl. All tasks are listed by default, but desired subset can be easily selected via specifying options. .SH "OPTIONS" .IX Header "OPTIONS" .SS "General Options" .IX Subsection "General Options" .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Display help message and exit. .IP "\fB\-v\fR, \fB\-\-version\fR" 4 .IX Item "-v, --version" Display version information and exit. .SS "Specifying Options" .IX Subsection "Specifying Options" .IP "\fB\-t\fR \fItask\fR, \fB\-\-task\fR \fItask\fR" 4 .IX Item "-t task, --task task" Specify the \fItask\fR name. .IP "\fB\-g\fR \fIgroup\fR, \fB\-\-group\fR \fIgroup\fR" 4 .IX Item "-g group, --group group" Specify the \fIgroup\fR name. The group name should be a single word with maximum of 10 characters, but longer names are shortened automatically. .IP "\fB\-d\fR \fIdate\fR, \fB\-\-date\fR \fIdate\fR" 4 .IX Item "-d date, --date date" Specify the due \fIdate\fR. Available options are \fBanytime\fR, \fBtoday\fR, \&\fByesterday\fR, \fBtomorrow\fR, \fBmonth\fR, \fByear\fR, or an exact date in the YYYY-MM-DD format, e.g. 2008\-06\-17 for 17 June 2008. .IP "\fB\-p\fR \fIpriority\fR, \fB\-\-priority\fR \fIpriority\fR" 4 .IX Item "-p priority, --priority priority" Specify the \fIpriority\fR. Available options are integers between \fB1\fR and \&\fB5\fR, where 1 represents the highest priority. .IP "\fB\-f\fR, \fB\-\-finished\fR" 4 .IX Item "-f, --finished" Specify the finished task. .IP "\fB\-u\fR, \fB\-\-unfinished\fR" 4 .IX Item "-u, --unfinished" Specify the unfinished task. .SS "Additional Options" .IX Subsection "Additional Options" .IP "\fB\-H\fR \fIheading\fR, \fB\-\-heading\fR \fIheading\fR" 4 .IX Item "-H heading, --heading heading" Use selected \fIheading\fR. .IP "\fB\-e\fR \fIencoding\fR, \fB\-\-encoding\fR \fIencoding\fR" 4 .IX Item "-e encoding, --encoding encoding" Specify the file \fIencoding\fR in a form recognised by the W3C \s-1HTML 4.01\s0 standard (e.g. the default \s-1UTF\-8\s0). .IP "\fB\-o\fR \fIfile\fR, \fB\-\-output\fR \fIfile\fR" 4 .IX Item "-o file, --output file" Use selected \fIfile\fR instead of the standard output. .IP "\fB\-s\fR \fIfile\fR, \fB\-\-savefile\fR \fIfile\fR" 4 .IX Item "-s file, --savefile file" Use selected \fIfile\fR instead of the default \f(CW\*(C`~/.w2do\*(C'\fR as a save file. .IP "\fB\-k\fR, \fB\-\-preserve\fR" 4 .IX Item "-k, --preserve" Do not rewrite existing style sheet if present (e.g. because it contains some local changes). .IP "\fB\-b\fR, \fB\-\-bare\fR" 4 .IX Item "-b, --bare" Leave out the \s-1HTML\s0 header and footer. This is especially useful when you are planning to embed the list to another page. .IP "\fB\-B\fR, \fB\-\-no\-bare\fR" 4 .IX Item "-B, --no-bare" Include \s-1HTML\s0 header and footer; the default option. .IP "\fB\-i\fR, \fB\-\-inline\fR" 4 .IX Item "-i, --inline" Embed the style sheet to the page itself instead of creating a separate \s-1CSS\s0 file. Note that combining this option with \f(CW\*(C`\-b\*(C'\fR results in no style sheet at all. .IP "\fB\-I\fR, \fB\-\-no\-id\fR" 4 .IX Item "-I, --no-id" Do not include \s-1ID\s0 column in the listing. .IP "\fB\-\-with\-id\fR" 4 .IX Item "--with-id" Include \s-1ID\s0 column in the listing; the default option. .IP "\fB\-D\fR, \fB\-\-no\-date\fR" 4 .IX Item "-D, --no-date" Do not include due date column in the listing. .IP "\fB\-\-with\-date\fR" 4 .IX Item "--with-date" Include due date column in the listing; the default option. .IP "\fB\-P\fR, \fB\-\-no\-priority\fR" 4 .IX Item "-P, --no-priority" Do not include priority column in the listing. .IP "\fB\-\-with\-priority\fR" 4 .IX Item "--with-priority" Include priority column in the listing; the default option. .IP "\fB\-S\fR, \fB\-\-no\-state\fR" 4 .IX Item "-S, --no-state" Do not include state column in the listing. .IP "\fB\-\-with\-state\fR" 4 .IX Item "--with-state" Include state column in the listing; the default option. .IP "\fB\-\-with\-stats\fR, \fB\-\-stats\fR" 4 .IX Item "--with-stats, --stats" Include overall task list statistics. .IP "\fB\-\-no\-stats\fR" 4 .IX Item "--no-stats" Do not include overall task list statistics; the default option. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\fBW2DO_SAVEFILE\fR" 4 .IX Item "W2DO_SAVEFILE" Use selected file instead of the default \f(CW\*(C`~/.w2do\*(C'\fR as a save file. .SH "FILES" .IX Header "FILES" .IP "\fI~/.w2do\fR" 4 .IX Item "~/.w2do" Default save file. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBw2do\fR(1), \fBw2text\fR(1), \fBperl\fR(1). .SH "BUGS" .IX Header "BUGS" To report bugs or even send patches, you can either add new issue to the project bugtracker at , visit the discussion group at , or you can contact the author directly via e\-mail. .SH "AUTHOR" .IX Header "AUTHOR" Written by Jaromir Hradilek . .PP Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. .PP A copy of the license is included as a file called \s-1FDL\s0 in the main directory of the w2do source package. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2008, 2009, 2010 Jaromir Hradilek .PP This program is free software; see the source for copying conditions. It is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0