summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndreas Brachold <vdr07@deltab.de>2007-12-16 14:37:56 +0000
committerAndreas Brachold <vdr07@deltab.de>2007-12-16 14:37:56 +0000
commite74bdb7184b4e72ae58c5175464ef6a3db96aff7 (patch)
tree48b6c98ce3b2c5fd55a94f038c354b7f7e5bc42b /doc
parent26868547aed93bdba91157faa30db80db06573ba (diff)
downloadxxv-e74bdb7184b4e72ae58c5175464ef6a3db96aff7.tar.gz
xxv-e74bdb7184b4e72ae58c5175464ef6a3db96aff7.tar.bz2
* VTX: Embedded vtx-font inside module, drop graphics from VTXPATH
* HTTPD: remove binary from url as parameter, now defined at cmdobj, inside modul header * EPG: rename VPS to PDC, Programme Delivery Control * tools: add con_err,con_msg to dump message on console and log file * RECORDS: Show message after editing recording * MUSIC: remove proxy from playlist building, use proxy only to playing files
Diffstat (limited to 'doc')
-rw-r--r--doc/docu.tmpl2
-rw-r--r--doc/xxvd.1101
-rw-r--r--doc/xxvd.sgml9
3 files changed, 60 insertions, 52 deletions
diff --git a/doc/docu.tmpl b/doc/docu.tmpl
index aee6b15..00342ea 100644
--- a/doc/docu.tmpl
+++ b/doc/docu.tmpl
@@ -66,11 +66,13 @@ XXV::MODULES::<?% Name %?>
<?% FOREACH cmdname = Commands.keys.sort %?>
+<?% IF Commands.$cmdname.hidden != 'yes' %?>
=item * <?% cmdname %?> (<?% Commands.$cmdname.short %?>)
<?% Commands.$cmdname.description %?>
<?% END %?>
+<?% END %?>
=back
diff --git a/doc/xxvd.1 b/doc/xxvd.1
index 79176c6..a334ab3 100644
--- a/doc/xxvd.1
+++ b/doc/xxvd.1
@@ -1,8 +1,24 @@
-.TH xxvd 1 "July 14, 2007"
+'\" -*- coding: us-ascii -*-
+.if \n(.g .ds T< \\FC
+.if \n(.g .ds T> \\F[\n[.fam]]
+.de URL
+\\$2 \(la\\$1\(ra\\$3
+..
+.if \n(.g .mso www.tmac
+.TH xxvd 1 "December 16, 2007" "" ""
.SH NAME
XXV \- (Xtreme eXtension for VDR) provides a central service to administer VDR
.SH SYNOPSIS
-\fBxxvd\fR [\fB\-\-configfile=\fR \fBFILE\fR] [\fB\-\-logfile=\fR \fBFILE\fR] [\fB\-\-pidfile=\fR \fBFILE\fR] [\fB\-\-localedir=\fR \fBDIR\fR] [\fB\-\-moduledir=\fR \fBDIR\fR] [\fB\-\-docudir=\fR \fBDIR\fR] [\fB\-\-poddir=\fR \fBDIR\fR] [\fB\-\-htmldir=\fR \fBDIR\fR] [\fB\-\-fontdir=\fR \fBDIR\fR] [\fB\-\-vtxdir=\fR \fBDIR\fR] [\fB\-\-newsmods=\fR \fBDIR\fR] [\fB\-\-newstmpl=\fR \fBDIR\fR] [\fB\-\-kill\fR] [\fB\-\-verbose=\fR \fBLEVEL\fR] [\fB\-\-version\fR] [\fB\-\-nofork\fR]
+'nh
+.fi
+.ad l
+\fBxxvd\fR \kx
+.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
+'in \n(.iu+\nxu
+[\fB--configfile=\fR \fIFILE\fR] [\fB--logfile=\fR \fIFILE\fR] [\fB--pidfile=\fR \fIFILE\fR] [\fB--localedir=\fR \fIDIR\fR] [\fB--moduledir=\fR \fIDIR\fR] [\fB--docudir=\fR \fIDIR\fR] [\fB--poddir=\fR \fIDIR\fR] [\fB--htmldir=\fR \fIDIR\fR] [\fB--fontdir=\fR \fIDIR\fR] [\fB--newsmods=\fR \fIDIR\fR] [\fB--newstmpl=\fR \fIDIR\fR] [\fB--kill\fR] [\fB--verbose=\fR \fILEVEL\fR] [\fB--version\fR] [\fB--nofork\fR]
+'in \n(.iu-\nxu
+.ad b
+'hy
.SH DESCRIPTION
\fBxxvd\fR is daemon behind XXV.
XXV provides a central service to administer VDR, it's contain
@@ -11,84 +27,81 @@ And is extendable by plugins and skins. XXV allows to manage
timers, auto timers, channels, recordings and much more provided by VDR
.SH OPTIONS
.TP
-\-\-configfile=\fIFILE\fR
-Use \fBFILE\fR as config file for XXV.
-The config file is modified by XXV, so it shall not be read\-only.
+--configfile=\fIFILE\fR
+Use \*(T<\fIFILE\fR\*(T> as config file for XXV.
+The config file is modified by XXV, so it shall not be read-only.
.TP
-\-\-logfile=\fIFILE\fR.
-Output all log messages to \fBFILE\fR.
+--logfile=\fIFILE\fR.
+Output all log messages to \*(T<\fIFILE\fR\*(T>.
.TP
-\-\-pidfile=\fIFILE\fR
-Write process id of \fBxxvd\fR daemon to \fBFILE\fR.
+--pidfile=\fIFILE\fR
+Write process id of \fBxxvd\fR daemon to \*(T<\fIFILE\fR\*(T>.
.TP
-\-\-localedir=\fIDIR\fR
-Search for locales in \fBDIR\fR.
-\fBDIR\fR should contain the typical locales structure
+--localedir=\fIDIR\fR
+Search for locales in \*(T<\fIDIR\fR\*(T>.
+\*(T<\fIDIR\fR\*(T> should contain the typical locales structure
with XXV's translations. (eg. de/LC_MESSAGES/xxv.mo)
.TP
-\-\-moduledir=\fIDIR\fR
-Search for modules (plugins) in \fBDIR\fR.
+--moduledir=\fIDIR\fR
+Search for modules (plugins) in \*(T<\fIDIR\fR\*(T>.
.TP
-\-\-docudir=\fIDIR\fR
-Directory \fBDIR\fR with template files used for generate documentation.
+--docudir=\fIDIR\fR
+Directory \*(T<\fIDIR\fR\*(T> with template files used for generate documentation.
.TP
-\-\-poddir=\fIDIR\fR
-Generate the selfdocumentation files in \fBDIR\fR.
+--poddir=\fIDIR\fR
+Generate the selfdocumentation files in \*(T<\fIDIR\fR\*(T>.
Documentation files are generated by XXV, so it shall be writable.
.TP
-\-\-htmldir=\fIDIR\fR
-XXV searchs for it's html templates in \fBDIR\fR.
-Each subdirectory in \fBDIR\fR is seen as a set of
+--htmldir=\fIDIR\fR
+XXV searchs for it's html templates in \*(T<\fIDIR\fR\*(T>.
+Each subdirectory in \*(T<\fIDIR\fR\*(T> is seen as a set of
templates (Skin).
.TP
-\-\-fontdir=\fIDIR\fR
-XXV searchs usable fonts in \fBDIR\fR.
+--fontdir=\fIDIR\fR
+XXV searchs usable fonts in \*(T<\fIDIR\fR\*(T>.
.TP
-\-\-vtxdir=\fIDIR\fR
-XXV module VTX use font images from \fBDIR\fR.
+--contrib=\fIDIR\fR
+XXV use some external scripts in \*(T<\fIDIR\fR\*(T>.
.TP
-\-\-contrib=\fIDIR\fR
-XXV use some external scripts in \fBDIR\fR.
+--newsmods=\fIDIR\fR
+\fBxxvd\fR search for news modules (news plugins) in \*(T<\fIDIR\fR\*(T>.
.TP
-\-\-newsmods=\fIDIR\fR
-\fBxxvd\fR search for news modules (news plugins) in \fBDIR\fR.
+--newstmpl=\fIDIR\fR
+XXV searches for news templates in \*(T<\fIDIR\fR\*(T>.
.TP
-\-\-newstmpl=\fIDIR\fR
-XXV searches for news templates in \fBDIR\fR.
-.TP
-\-\-kill
+--kill
Kill daemon \fBxxvd\fR.
.TP
-\-\-verbose=\fILEVEL\fR
+--verbose=\fILEVEL\fR
Select the verbose \fILEVEL\fR of the logged
messages of XXV.
.RS
.TP 0.2i
\(bu
-0 \- Don't log messages
+0 - Don't log messages
.TP 0.2i
\(bu
-1 \- Errors only
+1 - Errors only
.TP 0.2i
\(bu
-2 \- Messages depends user action
+2 - Messages depends user action
.TP 0.2i
\(bu
-3 \- More events
+3 - More events
.TP 0.2i
\(bu
-5 \- Lots of messages
+5 - Lots of messages
.TP 0.2i
\(bu
->5 \- Messages with dump of caller stack
+>5 - Messages with dump of caller stack
.RE
.TP
-\-\-version
+--version
Display the version number and exit.
.TP
-\-\-nofork
+--nofork
Debug mode: don't fork to the background.
.SH AUTHOR
-This manual page was written by Tobias Grimm<tg@e\-tobi.net>.
+This manual page was written by Tobias Grimm<<\*(T<tg@e\-tobi.net\*(T>>>.
.PP
-(July 14, 2007)
+(December 16, 2007)
diff --git a/doc/xxvd.sgml b/doc/xxvd.sgml
index 3cdaa87..b2add7d 100644
--- a/doc/xxvd.sgml
+++ b/doc/xxvd.sgml
@@ -4,7 +4,7 @@
[
<!ENTITY dhfirstname "<firstname>Tobias</firstname>">
<!ENTITY dhsurname "<surname>Grimm</surname>">
- <!ENTITY date "July 14, 2007">
+ <!ENTITY date "December 16, 2007">
<!ENTITY dhdate "<date>&date;</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>tg@e-tobi.net</email>">
@@ -45,7 +45,6 @@
<arg><option>--poddir=</option><replaceable>DIR</replaceable></arg>
<arg><option>--htmldir=</option><replaceable>DIR</replaceable></arg>
<arg><option>--fontdir=</option><replaceable>DIR</replaceable></arg>
- <arg><option>--vtxdir=</option><replaceable>DIR</replaceable></arg>
<arg><option>--newsmods=</option><replaceable>DIR</replaceable></arg>
<arg><option>--newstmpl=</option><replaceable>DIR</replaceable></arg>
<arg><option>--kill</option></arg>
@@ -127,12 +126,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term>--vtxdir=<replaceable class="parameter">DIR</replaceable></term>
- <listitem>
- <para>&dhpackage; module VTX use font images from <filename>DIR</filename>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>--contrib=<replaceable class="parameter">DIR</replaceable></term>
<listitem>
<para>&dhpackage; use some external scripts in <filename>DIR</filename>.</para>