[vdr] [PATCH] vdr.1, vdr.5 and UTF-8

[Darren Salt <linux@youmustbejoking.demon.co.uk>]

Even if vdr doesn't get along with UTF-8 locales, there's no reason why the
man pages shouldn't be properly displayable in them. The attached patch fixes
this by escaping hyphens in option names and replacing non-ASCII characters
with equivalent macros.

-- 
| Darren Salt | d youmustbejoking,demon,co,uk | nr. Ashington,
| Debian,     | s zap,tartarus,org            | Northumberland
| RISC OS     | @                             | Toon Army
|   <URL:http://www.youmustbejoking.demon.co.uk/> (PGP 2.6, GPG keys)

Experience is what enables us to make a new mistake each time.
diff -urNad vdr-1.3.15/vdr.1 /tmp/dpep.0MmCue/vdr-1.3.15/vdr.1
--- vdr-1.3.15/vdr.1	2004-11-02 01:43:41.000000000 +0000
+++ /tmp/dpep.0MmCue/vdr-1.3.15/vdr.1	2004-11-02 01:43:41.000000000 +0000
@@ -12,7 +12,7 @@
 .\"
 .TH vdr 1 "1 June 2003" "1.2.0" "Video Disk Recorder"
 .SH NAME
-vdr - the Video Disk Recorder
+vdr \- the Video Disk Recorder
 .SH SYNOPSIS
 .B vdr
 [options]
@@ -38,31 +38,31 @@
 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 @@
 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
@@ -193,7 +193,7 @@
 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.
 
diff -urNad vdr-1.3.15/vdr.5 /tmp/dpep.0MmCue/vdr-1.3.15/vdr.5
--- vdr-1.3.15/vdr.5	2004-11-02 01:43:40.000000000 +0000
+++ /tmp/dpep.0MmCue/vdr-1.3.15/vdr.5	2004-11-02 01:43:41.000000000 +0000
@@ -12,7 +12,7 @@
 .\"
 .TH vdr 5 "31 Oct 2004" "1.3.15" "Video Disk Recorder Files"
 .SH NAME
-vdr file formats - the Video Disk Recorder Files
+vdr file formats \- the Video Disk Recorder Files
 .SH DESCRIPTION
 This page describes the formats of the various files \fBvdr\fR uses to
 store configuration data and recordings.
@@ -174,12 +174,12 @@
 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 @@
 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 @@
 
 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 @@
 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,7 +465,7 @@
 .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
 
@@ -511,7 +511,7 @@
 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 @@
 
 \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,7 +646,7 @@
 .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.