Merge pull request #583 from proski/man-subst

Substitute variables in manual pages

docs/man/.gitignore

@@ -0,0 +1 @@
+*.[1-8]

docs/man/Makefile.am

@@ -1,4 +1,4 @@
-dist_man_MANS = \
+man_MANS = \
   xrdp-dis.1 \
   sesman.ini.5 \
   xrdp.ini.5 \
@@ -11,7 +11,16 @@ dist_man_MANS = \
   xrdp-sesrun.8 \
   xrdp-sessvc.8
 
-noinst_man_MANS = \
+EXTRA_DIST = $(man_MANS:=.in)
-  xrdp-xcon.8
 
-EXTRA_DIST = $(noinst_man_MANS)
+SUBST_VARS = sed \
+   -e 's|@PACKAGE_VERSION[@]|$(PACKAGE_VERSION)|g' \
+   -e 's|@bindir[@]|$(bindir)|g' \
+   -e 's|@localstatedir[@]|$(localstatedir)|g' \
+   -e 's|@sysconfdir[@]|$(sysconfdir)|g'
+
+SUFFIXES = .in
+.in:
+	$(SUBST_VARS) $< > $@
+
+CLEANFILES = $(man_MANS)

docs/man/sesman.ini.5.in

@@ -1,5 +1,5 @@
 .\"
-.TH "sesman.ini" "5" "0.9.1" "xrdp team" ""
+.TH "sesman.ini" "5" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 \fBsesman.ini\fR \- Configuration file for \fBxrdp-sesman\fR(8)
 
@@ -214,7 +214,7 @@ All entries in the \fB[SessionVariables]\fR section are set as
 environment variables in the user's session.
 
 .SH "FILES"
-/etc/xrdp/sesman.ini
+@sysconfdir@/xrdp/sesman.ini
 
 .SH "SEE ALSO"
 .BR xrdp-sesman (8),

docs/man/xrdp-chansrv.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp\-chansrv" "8" "0.9.1" "xrdp team" ""
+.TH "xrdp\-chansrv" "8" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 \fBxrdp\-chansrv\fR \- \fBxrdp\fR channel server
 

docs/man/xrdp-dis.1.in

@@ -1,4 +1,4 @@
-.TH "xrdp-dis" "1" "0.9.1" "xrdp team"
+.TH "xrdp-dis" "1" "@PACKAGE_VERSION@" "xrdp team"
 .SH NAME
 xrdp\-dis \- xrdp disconnect utility
 

docs/man/xrdp-genkeymap.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp\-genkeymap" "8" "0.9.1" "xrdp team" ""
+.TH "xrdp\-genkeymap" "8" "@PACKAGE_VERSION@" "xrdp team" ""
 .de URL
 . \\$2 \(laURL: \\$1 \(ra\\$3
 ..
@@ -21,7 +21,7 @@ The key map information is stored in the file named \fIoutfile\fP.
 
 .SH "FILES"
 .TP
-.I /etc/xrdp/km-XXXXXXXX.ini
+.I @sysconfdir@/xrdp/km-XXXXXXXX.ini
 Files containing the keyboard mapping for language \fIXXXXXXXX\fP, which is a 8 digit hexadecimal number identifying the country and language code.
 .RS 8
 .TP

docs/man/xrdp-keygen.8.in

@@ -3,7 +3,7 @@
 .\" Copyright © 2007, 2008 Vincent Bernat <bernat@debian.org>
 .\" License: GPL-2+
 .\"-
-.TH xrdp\-keygen 8 "0.9.1" "xrdp team"
+.TH xrdp\-keygen 8 "@PACKAGE_VERSION@" "xrdp team"
 .SH NAME
 xrdp\-keygen \- xrdp RSA key generation utility
 
@@ -15,7 +15,7 @@ xrdp\-keygen \- xrdp RSA key generation utility
 
 .SH DESCRIPTION
 \fBxrdp\-keygen\fP generates the file
-.I /etc/xrdp/rsakeys.ini
+.I @sysconfdir@/xrdp/rsakeys.ini
 which contains the RSA key pair used to perform authentication to
 remote clients. The public key is self-signed.
 
@@ -26,14 +26,14 @@ This program takes one of the following options:
 Generate a new key pair.
 The key data is stored in the file named \fIoutfile\fP.
 .br
-If \fBauto\fP is used as \fIoutfile\fP, the default file \fI/etc/xrdp/rsakeys.ini\fP gets created if it does not yet exists.
+If \fBauto\fP is used as \fIoutfile\fP, the default file \fI@sysconfdir@/xrdp/rsakeys.ini\fP gets created if it does not yet exists.
 .TP
 .B test
 Generate a test key pair and print information to standard output.
 
 .SH FILES
 .TP
-.I /etc/xrdp/rsakeys.ini
+.I @sysconfdir@/xrdp/rsakeys.ini
 RSA public and private key pair used to identify this XRDP server.
 
 .SH SEE ALSO

docs/man/xrdp-sesadmin.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp-sesadmin" "8" "0.9.1" "xrdp team"
+.TH "xrdp-sesadmin" "8" "@PACKAGE_VERSION@" "xrdp team"
 .SH NAME
 xrdp\-sesadmin \- console XRDP sessions administration tool
 

docs/man/xrdp-sesman.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp\-sesman" "8" "0.9.1" "xrdp team" ""
+.TH "xrdp\-sesman" "8" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 xrdp\-sesman \- \fBxrdp\fR(8) session manager
 
@@ -23,15 +23,15 @@ Kills running \fBxrdp\-sesman\fR daemon.
 Output help information and exit.
 
 .SH "FILES"
-${SESMAN_BIN_DIR}/sesman
+@bindir@/sesman
 .br
-${SESMAN_BIN_DIR}/sesrun
+@bindir@/sesrun
 .br
-${SESMAN_CFG_DIR}/sesman.ini
+@sysconfdir@/xrdp/sesman.ini
 .br
-${SESMAN_LOG_DIR}/sesman.log
+@localstatedir@/log/sesman.log
 .br
-${SESMAN_PID_DIR}/sesman.pid
+@localstatedir@/run/sesman.pid
 
 .SH "AUTHORS"
 Jay Sorg <jsorg71@users.sourceforge.net>

docs/man/xrdp-sesrun.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp\-sesrun" "8" "0.9.1" "xrdp team" ""
+.TH "xrdp\-sesrun" "8" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 xrdp\-sesrun \- \fBsesman\fR(8) session launcher
 
@@ -32,9 +32,9 @@ Screen height
 Session color depth
 
 .SH "FILES"
-${SESMAN_BIN_DIR}/sesman
+@bindir@/sesman
 .br
-${SESMAN_BIN_DIR}/sesrun
+@bindir@/sesrun
 
 .SH "AUTHORS"
 Jay Sorg <jsorg71@users.sourceforge.net>

docs/man/xrdp-sessvc.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp\-sessvc" "8" "0.9.1" "xrdp team" ""
+.TH "xrdp\-sessvc" "8" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 xrdp\-sessvc \- \fBxrdp\fR session supervisor
 

docs/man/xrdp-xcon.8

@@ -1,14 +0,0 @@
-.TH "xrdp-xcon" "8" "0.9.1" "xrdp team"
-.SH NAME
-xrdp\-xcon \- X11 event loop debugging helper for XRDP
-
-.SH SYNOPSIS
-.B xrdp\-xcon
-
-.SH DESCRIPTION
-.PP
-\fBxrdp\-xcon\fP is a X application, which just opens a connection to the X server and polls for events.
-It's pretty useless.
-
-.SH SEE ALSO
-.BR xev (1).

docs/man/xrdp.8.in

@@ -1,4 +1,4 @@
-.TH "xrdp" "8" "0.9.1" "xrdp team" ""
+.TH "xrdp" "8" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 \fBxrdp\fR \- a Remote Desktop Protocol (RDP) server
 
@@ -7,34 +7,34 @@ xrdp [ \-\-nodaemon | \-\-kill | \-\-help ]
 
 .SH "DESCRIPTION"
 \fBxrdp\fR is a Remote Desktop Protocol (RDP) Server.
-.br 
+.br
 Unlike Windows NT/2000/2003 server, \fBxrdp\fR will not display a Windows desktop but an X window desktop to the user.
 
 It can also be used as a VNC\->RDP bridge.
 
 .SH "OPTIONS"
-.TP 
+.TP
-\fB\-n\fR, \fB\-\-nodaemon\fR 
+\fB\-n\fR, \fB\-\-nodaemon\fR
 Starts \fBxrdp\fR in foreground instead of starting it as a daemon.
-.TP 
+.TP
 \fB\-k\fR, \fB\-\-kill\fR
 Kills running \fBxrdp\fR daemon.
-.TP 
+.TP
 \fB\-h\fR, \fB\-\-help\fR
 Output help information and exit.
 
 .SH "FILES"
-${XRDP_BIN_DIR}/xrdp
+@bindir@/xrdp
-.br 
+.br
-${XRDP_CFG_DIR}/xrdp.ini
+@sysconfdir@/xrdp/xrdp.ini
-.br 
+.br
-${XRDP_LOG_DIR}/xrdp.log
+@localstatedir@/log/xrdp.log
-.br 
+.br
-${XRDP_PID_DIR}/xrdp.pid
+@localstatedir@/run/xrdp.pid
 
 .SH "AUTHORS"
 Jay Sorg <jsorg71@users.sourceforge.net>
-.br 
+.br
 Simone Fedele <ilsimo@users.sourceforge.net>
 
 .SH "SEE ALSO"

docs/man/xrdp.ini.5.in

@@ -1,4 +1,4 @@
-.TH "xrdp.ini" "5" "0.9.1" "xrdp team" ""
+.TH "xrdp.ini" "5" "@PACKAGE_VERSION@" "xrdp team" ""
 .SH "NAME"
 \fBxrdp.ini\fR \- Configuration file for \fBxrdp\fR(8)
 
@@ -54,7 +54,7 @@ If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables compression of bu
 .TP
 \fBkey_file\fP=\fI/path/to/private_key\fP
 Set location of TLS certificate and private key. They must be written in PEM format.
-If not specified, defaults to \fB${XRDP_CFG_DIR}/cert.pem\fP, \fB${XRDP_CFG_DIR}/key.pem\fP.
+If not specified, defaults to \fB@sysconfdir@/xrdp/cert.pem\fP, \fB@sysconfdir@/xrdp/key.pem\fP.
 
 This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP.
 
@@ -206,8 +206,8 @@ The highest value is 255 (hex FF).
 The following parameters can be used in the \fB[Logging]\fR section:
 
 .TP
-\fBLogFile\fR=\fI${SESMAN_LOG_DIR}/sesman.log\fR
+\fBLogFile\fR=\fI@localstatedir@/log/sesman.log\fR
-This options contains the path to logfile. It can be either absolute or relative, and the default is \fI${SESMAN_LOG_DIR}/sesman.log\fR
+This options contains the path to logfile. It can be either absolute or relative.\fR
 
 .TP
 \fBLogLevel\fR=\fIlevel\fR
@@ -320,7 +320,7 @@ port=\-1
 .fi
 
 .SH "FILES"
-${XRDP_CFG_DIR}/xrdp.ini
+@sysconfdir@/xrdp/xrdp.ini
 
 .SH "SEE ALSO"
 .BR xrdp (8),