summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndreas Brachold <vdr07@deltab.de>2008-03-08 14:30:15 +0000
committerAndreas Brachold <vdr07@deltab.de>2008-03-08 14:30:15 +0000
commita420ba2fd04bb2adce1c693fc8d296f332bdd95c (patch)
tree625f296d92a0f370b6fe16e8fd3d15aa4c4ba4d7 /doc
parent3d506c66cc8ec133730edddeaff4bd2ffd8a129b (diff)
downloadxxv-a420ba2fd04bb2adce1c693fc8d296f332bdd95c.tar.gz
xxv-a420ba2fd04bb2adce1c693fc8d296f332bdd95c.tar.bz2
Charset UTF8 Support. Run 'xxvd --utf8' to use encoding utf8 as data charset.
Diffstat (limited to 'doc')
-rw-r--r--doc/xxvd.159
-rw-r--r--doc/xxvd.sgml86
2 files changed, 78 insertions, 67 deletions
diff --git a/doc/xxvd.1 b/doc/xxvd.1
index a334ab3..0e1246c 100644
--- a/doc/xxvd.1
+++ b/doc/xxvd.1
@@ -5,9 +5,9 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH xxvd 1 "December 16, 2007" "" ""
+.TH xxvd 1 "March 08, 2008" "" ""
.SH NAME
-XXV \- (Xtreme eXtension for VDR) provides a central service to administer VDR
+XXV \- means "Xtreme eXtension for VDR" and is a central service for the administration of the VDR and his environment.
.SH SYNOPSIS
'nh
.fi
@@ -15,7 +15,7 @@ XXV \- (Xtreme eXtension for VDR) provides a central service to administer VDR
\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]
+[\fB--configfile=\fR \fIFILE\fR] [\fB--logfile=\fR \fIFILE\fR] [\fB--pidfile=\fR \fIFILE\fR] [\fB--localedir=\fR \fIDIRECTORY\fR] [\fB--moduledir=\fR \fIDIRECTORY\fR] [\fB--docudir=\fR \fIDIRECTORY\fR] [\fB--poddir=\fR \fIDIRECTORY\fR] [\fB--htmldir=\fR \fIDIRECTORY\fR] [\fB--fontdir=\fR \fIDIRECTORY\fR] [\fB--newsmods=\fR \fIDIRECTORY\fR] [\fB--newstmpl=\fR \fIDIRECTORY\fR] [\fB--verbose=\fR \fILEVEL\fR] [\fB--utf8\fR] [\fB--version\fR] [\fB--nofork\fR] [\fB--kill\fR]
'in \n(.iu-\nxu
.ad b
'hy
@@ -37,40 +37,37 @@ Output all log messages to \*(T<\fIFILE\fR\*(T>.
--pidfile=\fIFILE\fR
Write process id of \fBxxvd\fR daemon to \*(T<\fIFILE\fR\*(T>.
.TP
---localedir=\fIDIR\fR
-Search for locales in \*(T<\fIDIR\fR\*(T>.
-\*(T<\fIDIR\fR\*(T> should contain the typical locales structure
+--localedir=\fIDIRECTORY\fR
+Search for locales in \*(T<\fIDIRECTORY\fR\*(T>.
+\*(T<\fIDIRECTORY\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 \*(T<\fIDIR\fR\*(T>.
+--moduledir=\fIDIRECTORY\fR
+Search for modules (plugins) in \*(T<\fIDIRECTORY\fR\*(T>.
.TP
---docudir=\fIDIR\fR
-Directory \*(T<\fIDIR\fR\*(T> with template files used for generate documentation.
+--docudir=\fIDIRECTORY\fR
+\*(T<\fIDIRECTORY\fR\*(T> with template files used for generate documentation.
.TP
---poddir=\fIDIR\fR
-Generate the selfdocumentation files in \*(T<\fIDIR\fR\*(T>.
+--poddir=\fIDIRECTORY\fR
+Generate the selfdocumentation files in \*(T<\fIDIRECTORY\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 \*(T<\fIDIR\fR\*(T>.
-Each subdirectory in \*(T<\fIDIR\fR\*(T> is seen as a set of
+--htmldir=\fIDIRECTORY\fR
+XXV searchs for it's html templates in \*(T<\fIDIRECTORY\fR\*(T>.
+Each subdirectory in \*(T<\fIDIRECTORY\fR\*(T> is seen as a set of
templates (Skin).
.TP
---fontdir=\fIDIR\fR
-XXV searchs usable fonts in \*(T<\fIDIR\fR\*(T>.
+--fontdir=\fIDIRECTORY\fR
+XXV searchs usable fonts in \*(T<\fIDIRECTORY\fR\*(T>.
.TP
---contrib=\fIDIR\fR
-XXV use some external scripts in \*(T<\fIDIR\fR\*(T>.
+--contrib=\fIDIRECTORY\fR
+XXV use some external scripts in \*(T<\fIDIRECTORY\fR\*(T>.
.TP
---newsmods=\fIDIR\fR
-\fBxxvd\fR search for news modules (news plugins) in \*(T<\fIDIR\fR\*(T>.
+--newsmods=\fIDIRECTORY\fR
+\fBxxvd\fR search for news modules (news plugins) in \*(T<\fIDIRECTORY\fR\*(T>.
.TP
---newstmpl=\fIDIR\fR
-XXV searches for news templates in \*(T<\fIDIR\fR\*(T>.
-.TP
---kill
-Kill daemon \fBxxvd\fR.
+--newstmpl=\fIDIRECTORY\fR
+XXV searches for news templates in \*(T<\fIDIRECTORY\fR\*(T>.
.TP
--verbose=\fILEVEL\fR
Select the verbose \fILEVEL\fR of the logged
@@ -96,12 +93,18 @@ messages of XXV.
>5 - Messages with dump of caller stack
.RE
.TP
+--utf8
+Use encoding utf8 as data charset.
+.TP
--version
Display the version number and exit.
.TP
--nofork
Debug mode: don't fork to the background.
+.TP
+--kill
+Kill daemon \fBxxvd\fR.
.SH AUTHOR
-This manual page was written by Tobias Grimm<<\*(T<tg@e\-tobi.net\*(T>>>.
+This manual page was written by Tobias Grimm <<\*(T<tg@e\-tobi.net\*(T>>>.
.PP
-(December 16, 2007)
+(March 08, 2008)
diff --git a/doc/xxvd.sgml b/doc/xxvd.sgml
index b2add7d..c2c944e 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 "December 16, 2007">
+ <!ENTITY date "March 08, 2008">
<!ENTITY dhdate "<date>&date;</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>tg@e-tobi.net</email>">
@@ -23,7 +23,7 @@
<address>&dhemail;</address>
<author>&dhfirstname; &dhsurname;</author>
<copyright>
- <year>2005 - 2007</year>
+ <year>2005 - 2008</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
@@ -31,7 +31,8 @@
<refmeta>&dhucpackage; &dhsection;</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>(Xtreme eXtension for VDR) provides a central service to administer VDR</refpurpose>
+ <refpurpose>means "Xtreme eXtension for VDR" and is a central service for
+ the administration of the VDR and his environment.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
@@ -39,18 +40,19 @@
<arg><option>--configfile=</option><replaceable>FILE</replaceable></arg>
<arg><option>--logfile=</option><replaceable>FILE</replaceable></arg>
<arg><option>--pidfile=</option><replaceable>FILE</replaceable></arg>
- <arg><option>--localedir=</option><replaceable>DIR</replaceable></arg>
- <arg><option>--moduledir=</option><replaceable>DIR</replaceable></arg>
- <arg><option>--docudir=</option><replaceable>DIR</replaceable></arg>
- <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>--newsmods=</option><replaceable>DIR</replaceable></arg>
- <arg><option>--newstmpl=</option><replaceable>DIR</replaceable></arg>
- <arg><option>--kill</option></arg>
+ <arg><option>--localedir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--moduledir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--docudir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--poddir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--htmldir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--fontdir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--newsmods=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--newstmpl=</option><replaceable>DIRECTORY</replaceable></arg>
<arg><option>--verbose=</option><replaceable>LEVEL</replaceable></arg>
+ <arg><option>--utf8</option></arg>
<arg><option>--version</option></arg>
<arg><option>--nofork</option></arg>
+ <arg><option>--kill</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
@@ -85,68 +87,62 @@
</listitem>
</varlistentry>
<varlistentry>
- <term>--localedir=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--localedir=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>Search for locales in <filename>DIR</filename>.
- <filename>DIR</filename> should contain the typical locales structure
+ <para>Search for locales in <filename>DIRECTORY</filename>.
+ <filename>DIRECTORY</filename> should contain the typical locales structure
with &dhpackage;'s translations. (eg. de/LC_MESSAGES/xxv.mo)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--moduledir=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--moduledir=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>Search for modules (plugins) in <filename>DIR</filename>.</para>
+ <para>Search for modules (plugins) in <filename>DIRECTORY</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--docudir=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--docudir=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>Directory <filename>DIR</filename> with template files used for generate documentation.</para>
+ <para><filename>DIRECTORY</filename> with template files used for generate documentation.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--poddir=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--poddir=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>Generate the selfdocumentation files in <filename>DIR</filename>.
+ <para>Generate the selfdocumentation files in <filename>DIRECTORY</filename>.
Documentation files are generated by &dhpackage;, so it shall be writable.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--htmldir=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--htmldir=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>&dhpackage; searchs for it's html templates in <filename>DIR</filename>.
- Each subdirectory in <filename>DIR</filename> is seen as a set of
+ <para>&dhpackage; searchs for it's html templates in <filename>DIRECTORY</filename>.
+ Each subdirectory in <filename>DIRECTORY</filename> is seen as a set of
templates (Skin).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--fontdir=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--fontdir=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>&dhpackage; searchs usable fonts in <filename>DIR</filename>.</para>
+ <para>&dhpackage; searchs usable fonts in <filename>DIRECTORY</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--contrib=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--contrib=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>&dhpackage; use some external scripts in <filename>DIR</filename>.</para>
+ <para>&dhpackage; use some external scripts in <filename>DIRECTORY</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--newsmods=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--newsmods=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>&dhucpackage; search for news modules (news plugins) in <filename>DIR</filename>.</para>
+ <para>&dhucpackage; search for news modules (news plugins) in <filename>DIRECTORY</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--newstmpl=<replaceable class="parameter">DIR</replaceable></term>
+ <term>--newstmpl=<replaceable class="parameter">DIRECTORY</replaceable></term>
<listitem>
- <para>&dhpackage; searches for news templates in <filename>DIR</filename>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>--kill</term>
- <listitem>
- <para>Kill daemon &dhucpackage;.</para>
+ <para>&dhpackage; searches for news templates in <filename>DIRECTORY</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -166,6 +162,12 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term>--utf8</term>
+ <listitem>
+ <para>Use encoding utf8 as data charset.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>--version</term>
<listitem>
<para>Display the version number and exit.</para>
@@ -177,11 +179,17 @@
<para>Debug mode: don't fork to the background.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>--kill</term>
+ <listitem>
+ <para>Kill daemon &dhucpackage;.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
- <para>This manual page was written by &dhusername;&lt;&dhemail;&gt;.</para>
+ <para>This manual page was written by &dhusername; &lt;&dhemail;&gt;.</para>
<para>(&date;)</para>
</refsect1>
</refentry>