diff options
| -rw-r--r-- | CONTRIBUTORS | 4 | ||||
| -rw-r--r-- | HISTORY | 4 | ||||
| -rw-r--r-- | vdr.1 | 60 | ||||
| -rw-r--r-- | vdr.5 | 34 |
4 files changed, 54 insertions, 48 deletions
diff --git a/CONTRIBUTORS b/CONTRIBUTORS index fb69037f..3783a8cc 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -1176,3 +1176,7 @@ Dino Ravnic <dino.ravnic@fer.hr> Olaf Titz <olaf@bigred.inka.de> for fixing some typos in the Makefile's 'font' target + +Darren Salt <linux@youmustbejoking.demon.co.uk> + for pointing out that the '-' and 'ö' characters need to be escaped in the man + pages @@ -3160,7 +3160,7 @@ Video Disk Recorder Revision History right day of week for timers in the future. - Some improvements to cPoller (thanks to Marco Schlüßler). -2004-12-17: Version 1.3.18 +2004-12-18: Version 1.3.18 - Removed an unused variable from cTimer::GetWDayFromMDay() (thanks to Wayne Keer for reporting this one). @@ -3193,3 +3193,5 @@ Video Disk Recorder Revision History have their own idea about this. + cChannel::[AD]pid[12]() have been replaced with cChannel::[AD]pid(int i) to allow access to all available PIDs. +- Escaped the '-' and 'ö' characters in the man pages (thanks to Darren Salt for + pointing this out). @@ -2,15 +2,15 @@ .\" ** The above line should force tbl to be a preprocessor ** .\" Man page for vdr .\" -.\" Copyright (C) 2003 Klaus Schmidinger +.\" Copyright (C) 2004 Klaus Schmidinger .\" .\" You may distribute under the terms of the GNU General Public .\" License as specified in the file COPYING that comes with the .\" vdr distribution. .\" -.\" $Id: vdr.1 1.11 2004/06/13 14:48:03 kls Exp $ +.\" $Id: vdr.1 1.12 2004/12/18 12:40:47 kls Exp $ .\" -.TH vdr 1 "1 June 2003" "1.2.0" "Video Disk Recorder" +.TH vdr 1 "19 Dec 2004" "1.3.18" "Video Disk Recorder" .SH NAME vdr - the Video Disk Recorder .SH SYNOPSIS @@ -38,31 +38,31 @@ Remote access is possible via the "Simple Video Disk Recorder Protocol" (SVDRP), which can be accessed on port 2001, for instance by \fBtelnet\fR. .SH OPTIONS .TP -.BI -a\ cmd ,\ --audio= cmd +.BI \-a\ cmd ,\ \-\-audio= cmd Send Dolby Digital audio to stdin of command \fIcmd\fR. .TP -.BI -c\ dir ,\ --config= dir +.BI \-c\ dir ,\ \-\-config= dir Read config files from directory \fIdir\fR (default is to read them from the video directory). .TP -.B -d, --daemon +.B \-d, \-\-daemon Run in daemon mode. .TP -.BI -D\ num ,\ --device= num +.BI \-D\ num ,\ \-\-device= num Use only the given DVB device (\fInum\fR = 0, 1, 2...). -There may be several \fB-D\fR options (by default all DVB devices will be used). +There may be several \fB\-D\fR options (by default all DVB devices will be used). .TP -.BI -E\ file ,\ --epgfile= file +.BI \-E\ file ,\ \-\-epgfile= file Write the EPG data into the given \fIfile\fR (default is \fI/video/epg.data\fR). -Use \fB-E-\fR to disable this. +Use \fB\-E\-\fR to disable this. If \fIfile\fR is a directory, the file \fIepg.data\fR will be created in that directory. .TP -.B -h, --help +.B \-h, \-\-help Print a help message and exit. .TP -.BI -l\ level ,\ --log= level +.BI \-l\ level ,\ \-\-log= level Set logging to \fIlevel\fR. \fB0\fR\ =\ no logging, \fB1\fR\ =\ errors only, \fB2\fR\ =\ errors and info, \fB3\fR\ =\ errors, info and debug. @@ -70,54 +70,54 @@ The default logging level is \fB3\fR. If logging should be done to LOG_LOCALn instead of LOG_USER, add '.n' to LEVEL, as in 3.7 (n=0..7). .TP -.BI -L\ dir ,\ --lib= dir +.BI \-L\ dir ,\ \-\-lib= dir Search for plugins in directory \fIdir\fR (default is ./PLUGINS/lib). -There can be several \fB-L\fR options with different \fIdir\fR values. -Each of them will apply to the \fB-P\fR options following it. +There can be several \fB\-L\fR options with different \fIdir\fR values. +Each of them will apply to the \fB\-P\fR options following it. .TP -.B -m, --mute +.B \-m, \-\-mute Mute audio of the primary DVB device at startup. .TP -.BI -p\ port ,\ --port= port +.BI \-p\ port ,\ \-\-port= port Use \fIport\fR for SVDRP. A value of \fB0\fR turns off SVDRP. The default SVDRP port is \fB2001\fR. You need to edit the file \fIsvdrphosts.conf\fR in order to enable access to the SVDRP port. .TP -.BI -P\ options ,\ --plugin= options +.BI \-P\ options ,\ \-\-plugin= options Load a plugin, defined by the given \fIoptions\fR. The first word in \fIoptions\fR must be the name of an existing \fBvdr\fR plugin, optionally followed by a blank separated list of command line options for that plugin. If \fIoptions\fR contains any blanks, you need to enclose it in quotes, like for example -\fBvdr -P "abc -a -b xyz"\fR +\fBvdr \-P "abc \-a \-b xyz"\fR which would load a plugin named \fBabc\fR, giving it the command line options -\fB-a\ -b\ xyz\fR. If you want to load all available plugins (without any +\fB\-a\ \-b\ xyz\fR. If you want to load all available plugins (without any particular options) you can use -\fBvdr -P "*"\fR +\fBvdr \-P "*"\fR (note the quotes around the asterisk to prevent wildcard expansion). .TP -.BI -r\ cmd ,\ --record= cmd +.BI \-r\ cmd ,\ \-\-record= cmd Call \fIcmd\fR before and after a recording. .TP -.BI -s\ cmd ,\ --shutdown= cmd +.BI \-s\ cmd ,\ \-\-shutdown= cmd Call \fIcmd\fR to shutdown the computer. .TP -.BI -t\ tty ,\ --terminal= tty +.BI \-t\ tty ,\ \-\-terminal= tty Set the controlling terminal. .TP -.BI -v\ dir ,\ --video= dir +.BI \-v\ dir ,\ \-\-video= dir Use \fIdir\fR as video directory. The default is \fI/video\fR. .TP -.B -V, --version +.B \-V, \-\-version Print version information and exit. .TP -.BI -w\ sec ,\ --watchdog= sec +.BI \-w\ sec ,\ \-\-watchdog= sec Activate the watchdog timer with a timeout of \fIsec\fR seconds. A value of \fB0\fR (default) disables the watchdog. .SH EXIT STATUS @@ -127,7 +127,7 @@ Successful program execution. .TP .B 1 An error has been detected which requires the DVB driver and \fBvdr\fR -to be re-loaded. +to be reloaded. .TP .B 2 An non-recoverable error has been detected, \fBvdr\fR has given up. @@ -186,9 +186,9 @@ be used to trigger an update of the list of recordings in the "Recordings" menu. Written by Klaus Schmidinger, with contributions from many others. See the file \fICONTRIBUTORS\fR in the \fBvdr\fR source distribution. .SH REPORTING BUGS -Report bugs to <vdr-bugs@cadsoft.de>. +Report bugs to <vdr\-bugs@cadsoft.de>. .SH COPYRIGHT -Copyright \(co 2003 Klaus Schmidinger. +Copyright \(co 2004 Klaus Schmidinger. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -8,9 +8,9 @@ .\" License as specified in the file COPYING that comes with the .\" vdr distribution. .\" -.\" $Id: vdr.5 1.29 2004/10/31 12:13:43 kls Exp $ +.\" $Id: vdr.5 1.30 2004/12/18 12:40:47 kls Exp $ .\" -.TH vdr 5 "31 Oct 2004" "1.3.15" "Video Disk Recorder Files" +.TH vdr 5 "19 Dec 2004" "1.3.18" "Video Disk Recorder Files" .SH NAME vdr file formats - the Video Disk Recorder Files .SH DESCRIPTION @@ -174,12 +174,12 @@ NID, TID and SID are all equal). A particular channel can be uniquely identified by its \fBchannel\ ID\fR, which is a string that looks like this: -\fBS19.2E-1-1089-12003-0\fR +\fBS19.2E\-1\-1089\-12003\-0\fR The components of this string are the \fBSource\fR (S19.2E), \fBNID\fR (1), \fBTID\fR (1089), \fBSID\fR (12003) and \fBRID\fR (0) as defined above. The last part can be omitted if it is \fB0\fR, -so the above example could also be written as S19.2E-1-1089-12003). +so the above example could also be written as S19.2E\-1\-1089\-12003). .br The \fBchannel\ ID\fR is used in the \fItimers.conf\fR and \fIepg.data\fR files to properly identify the channels. @@ -195,7 +195,7 @@ The file \fItimers.conf\fR contains the timer setup. Each line contains one timer definition, with individual fields separated by ':' characters. Example: -\fB1:10:-T-----:2058:2150:50:5:Quarks & Co:\fR +\fB1:10:\-T\-\-\-\-\-:2058:2150:50:5:Quarks & Co:\fR The fields in a timer definition have the following meaning (from left to right): @@ -234,21 +234,21 @@ timer shall record. This must be in the range \fB1...31\fR. In case of a `repeating' timer this is a string consisting of exactly seven characters, where each character position corresponds to one day of the week -(with Monday being the first day). The character '-' at a certain position +(with Monday being the first day). The character '\-' at a certain position means that the timer shall not record on that day. Any other character will cause the timer to record on that day. Example: -.B MTWTF-- +.B MTWTF\-\- will define a timer that records on Monday thru Friday and does not record -on weekends. The same result could be achieved with \fBABCDE--\fR (this is +on weekends. The same result could be achieved with \fBABCDE\-\-\fR (this is used to allow setting the days with language specific characters). The day definition of a `repeating' timer may be followed by the date when that -timer shall hit for the first time. The format for this is \fB@YYYY-MM-DD\fR, +timer shall hit for the first time. The format for this is \fB@YYYY\-MM\-DD\fR, so a complete definition could look like this: -\fBMTWTF--@2002-02-18\fR +\fBMTWTF\-\-@2002\-02\-18\fR which would implement a timer that records Moday thru Friday, and will hit for the first time on or after February 18, 2002. @@ -416,7 +416,7 @@ and can be one of \fIRed\fR, \fIGreen\fR, \fIYellow\fR, \fIBlue\fR or keys, which will be executed just as if they had been pressed in the given sequence. The optional \fB@plugin\fR can be used to automatically select the given plugin from the main menu (provided that plugin has a main menu -entry). \fBplugin\fR is the name of the plugin, exactly as given in the -P +entry). \fBplugin\fR is the name of the plugin, exactly as given in the \-P option when starting VDR. There can be only one \fB@plugin\fR per key macro, and it implicitly adds an \fIOk\fR key to the macro definition (in order to actually select the plugins main menu entry), which counts against the total @@ -465,12 +465,12 @@ Check for new mail?: /usr/local/bin/checkmail 2>&1 .br CPU status: /usr/local/bin/cpustatus 2>&1 .br -Disk space: df -h | grep '/video' | awk '{ print 100 - $5 "% free"; }' +Disk space: df \-h | grep '/video' | awk '{ print 100 \- $5 "% free"; }' .br Calendar: date;echo;cal Note that the commands 'checkmail' and 'cpustatus' are only \fBexamples\fR! -Don't send emails to the author asking where to find these ;-) +Don't send emails to the author asking where to find these ;\-) .br The '?' at the end of the "Check for new mail?" entry will prompt the user whether this command shall really be executed. @@ -511,7 +511,7 @@ The file \fIsetup.conf\fR contains the basic configuration options for \fBvdr\fR Each line contains one option in the format "Name = Value". See the MANUAL file for a description of the available options. .SS THEMES -The files \fIthemes/<skin>-<theme>.theme\fR in the config directory contain the +The files \fIthemes/<skin>\-<theme>.theme\fR in the config directory contain the color theme definitions for the various skins. In the actual file names \fI<skin>\fR will be replaced by the name if the skin this theme belongs to, and \fI<theme>\fR will be the name of this theme. @@ -545,7 +545,7 @@ you can provide language specific descriptions as \fBDescription.eng = Shades of blue\fR .br -\fBDescription.ger = Blautöne\fR +\fBDescription.ger = Blaut\(:one\fR where the language code (as defined in VDR/i18n.c) is added to the keyword "Description", separated by a dot. You can enter as many language specific @@ -646,9 +646,9 @@ previous EPG scans. .SH AUTHOR Written by Klaus Schmidinger. .SH REPORTING BUGS -Report bugs to <vdr-bugs@cadsoft.de>. +Report bugs to <vdr\-bugs@cadsoft.de>. .SH COPYRIGHT -Copyright \(co 2003 Klaus Schmidinger. +Copyright \(co 2004 Klaus Schmidinger. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |