[X2Go-Commits] [x2gobroker] 02/02: update man pages
git-admin at x2go.org
git-admin at x2go.org
Tue Feb 25 13:56:37 CET 2014
This is an automated email from the git hooks/post-receive script.
x2go pushed a commit to branch master
in repository x2gobroker.
commit b8ad7afa5294b2bdc8f782f35d1f3bb77147e475
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date: Tue Feb 25 13:55:59 2014 +0100
update man pages
---
man/man1/x2gobroker-testauth.1 | 4 ++--
man/man1/x2gobroker.1 | 8 ++++----
man/man8/x2gobroker-authservice.8 | 10 +++++-----
man/man8/x2gobroker-daemon-debug.8 | 2 +-
man/man8/x2gobroker-keygen.8 | 2 +-
man/man8/x2gobroker-pubkeyauthorizer.8 | 6 +++---
6 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/man/man1/x2gobroker-testauth.1 b/man/man1/x2gobroker-testauth.1
index 7fea25f..24ba87b 100644
--- a/man/man1/x2gobroker-testauth.1
+++ b/man/man1/x2gobroker-testauth.1
@@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH x2gobroker-testauth 1 "Jan 2014" "Version 0.0.3.x" "X2Go Session Broker"
+.TH x2gobroker-testauth 1 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
.SH NAME
x2gobroker-testauth \- Session Broker for X2Go (Authentication Test Utility)
.SH SYNOPSIS
@@ -25,7 +25,7 @@ x2gobroker-testauth \- Session Broker for X2Go (Authentication Test Utility)
\fBx2gobroker-testauth\fR is an authentication test utility for X2Go Session Broker.
.PP
WARNING: please know that the credentials you use for testing broker authentication will
-get revealed in your shell's history file (e.g. ~/.bash_history).
+get revealed in your shell's history file (e.g. \fI~/.bash_history\fR).
.SH COMMON OPTIONS
\fBx2gobroker-testauth\fR displays some help on command line options:
.TP
diff --git a/man/man1/x2gobroker.1 b/man/man1/x2gobroker.1
index 5159d60..1ae8420 100644
--- a/man/man1/x2gobroker.1
+++ b/man/man1/x2gobroker.1
@@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH x2gobroker 1 "Jan 2014" "Version 0.0.3.x" "X2Go Session Broker"
+.TH x2gobroker 1 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
.SH NAME
x2gobroker \- Session Broker for X2Go
.SH SYNOPSIS
@@ -58,7 +58,7 @@ It is possible to enforce a stronger authentication via an additional pre\-share
cookie must be stored in a client-side file so that X2Go Client can access it and then pass it on to the X2Go
Session Broker (via the X2Go Client option \-\-auth-id=<fullpath-to-file>) while authenticating against the broker.
-The server-side cookie hash can be set in /etc/x2go/x2gobroker.conf (option: my-cookie). You have to set
+The server-side cookie hash can be set in \fI/etc/x2go/x2gobroker.conf\fR (option: my-cookie). You have to set
the option require-cookie-auth to true to enable the additional cookie comparison in the X2Go Session Broker.
.TP
\*(T<\fB\-\-profile-id, \-\-sid SESSION_PROFILE_ID\fR\*(T>
@@ -76,10 +76,10 @@ The [address:]port that the Tornado http-engine will bind to (default: 127.0.0.1
Fork this application to background and detach from the running terminal.
.TP
\*(T<\fB\-P, \-\-pidfile\fR\*(T>
-Custom PID file location when daemonizing (default: <RUNDIR>/x2gobroker/x2gobroker-daemon.pid).
+Custom PID file location when daemonizing (default: \fI<RUNDIR>/x2gobroker/x2gobroker-daemon.pid\fR).
.TP
\*(T<\fB\-L, \-\-logdir\fR\*(T>
-Directory where stdout/stderr will be redirected after having daemonized (default: /var/log/x2gobroker/).
+Directory where stdout/stderr will be redirected after having daemonized (default: \fI/var/log/x2gobroker/\fR).
.TP
\*(T<\fB\-D, \-\-drop\-privileges\fR\*(T>
If started as root, drop privileges to uid X2GO_DAEMON_USER and gid X2GO_DAEMON_GROUP (as configured
diff --git a/man/man8/x2gobroker-authservice.8 b/man/man8/x2gobroker-authservice.8
index 65af01f..eff8569 100644
--- a/man/man8/x2gobroker-authservice.8
+++ b/man/man8/x2gobroker-authservice.8
@@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH x2gobroker-authservice 8 "Jan 2014" "Version 0.0.3.x" "X2Go Session Broker"
+.TH x2gobroker-authservice 8 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
.SH NAME
x2gobroker-authservice \- PAM authentication service for X2Go Session Broker
.SH SYNOPSIS
@@ -29,7 +29,7 @@ requires root privileges in most cases (esp. for pam_unix.so).
.PP
Thus, the PAM authentication has been moved into a separate service. The communication
between X2Go Session Broker and PAM Authentication Service is handled through a
-unix domain socket file ($RUNDIR/x2gobroker/x2gobroker-authservice.socket).
+unix domain socket file (\fI<RUNDIR>/x2gobroker/x2gobroker-authservice.socket\fR).
.PP
This command is normally started through an init script.
.SH COMMON OPTIONS
@@ -42,10 +42,10 @@ Display a help with all available command line options and exit.
Fork this application to background and detach from the running terminal.
.TP
\*(T<\fB\-P, \-\-pidfile\fR\*(T>
-Custom PID file location when daemonizing (default: <RUNDIR>/x2gobroker/x2gobroker-authservice.pid).
+Custom PID file location when daemonizing (default: \fI<RUNDIR>/x2gobroker/x2gobroker-authservice.pid\fR).
.TP
\*(T<\fB\-L, \-\-logdir\fR\*(T>
-Directory where stdout/stderr will be redirected after having daemonized (default: /var/log/x2gobroker/).
+Directory where stdout/stderr will be redirected after having daemonized (default: \fI/var/log/x2gobroker/\fR).
.TP
\*(T<\fB\-s <AUTHSOCKET>, \-\-socket <AUTHSOCKET>\fR\*(T>
File name of the unix domain socket file used for communication between broker and authentication service.
@@ -59,7 +59,7 @@ Group ownership of the \fI<AUTHSOCKET>\fR file.
\*(T<\fB\-p <PERMISSIONS>, \-\-permissions <PERMISSIONS>\fR\*(T>
Set these file permissions for the \fI<AUTHSOCKET>\fR file. Use numerical permissions (e.g. 0640).
.SH "FILES"
-$RUNDIR/x2gobroker/x2gobroker-authservice.socket
+<RUNDIR>/x2gobroker/x2gobroker-authservice.socket
.SH AUTHOR
This manual has been written for the X2Go project by
Mike Gabriel <mike.gabriel at das-netzwerkteam.de>.
diff --git a/man/man8/x2gobroker-daemon-debug.8 b/man/man8/x2gobroker-daemon-debug.8
index eb200cf..4f654ec 100644
--- a/man/man8/x2gobroker-daemon-debug.8
+++ b/man/man8/x2gobroker-daemon-debug.8
@@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH x2gobroker-daemon-debug 8 "Jan 2014" "Version 0.0.3.x" "X2Go Session Broker"
+.TH x2gobroker-daemon-debug 8 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
.SH NAME
x2gobroker-daemon-debug \- Debug X2Go Session Broker's Standalone Daemon
.SH SYNOPSIS
diff --git a/man/man8/x2gobroker-keygen.8 b/man/man8/x2gobroker-keygen.8
index f1e5531..0ce7be5 100644
--- a/man/man8/x2gobroker-keygen.8
+++ b/man/man8/x2gobroker-keygen.8
@@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH x2gobroker-keygen 8 "Jan 2014" "Version 0.0.3.x" "X2Go Session Broker"
+.TH x2gobroker-keygen 8 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
.SH NAME
x2gobroker-keygen \- Generate SSH keys for X2Go Session Broker
.SH SYNOPSIS
diff --git a/man/man8/x2gobroker-pubkeyauthorizer.8 b/man/man8/x2gobroker-pubkeyauthorizer.8
index 2db6dbe..8d9ee9c 100644
--- a/man/man8/x2gobroker-pubkeyauthorizer.8
+++ b/man/man8/x2gobroker-pubkeyauthorizer.8
@@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH x2gobroker-pubkeyauthorizer 8 "Jan 2014" "Version 0.0.3.x" "X2Go Session Broker"
+.TH x2gobroker-pubkeyauthorizer 8 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
.SH NAME
x2gobroker-pubkeyauthorizer \- Retrieve public SSH keys from an X2Go Session Broker
.SH SYNOPSIS
@@ -23,7 +23,7 @@ x2gobroker-pubkeyauthorizer \- Retrieve public SSH keys from an X2Go Session Bro
'hy
.SH DESCRIPTION
\fBx2gobroker-pubkeyauthorizer\fR retrieves the X2Go Session Broker's public SSH key(s) and
-adds it to ~x2gobroker/.ssh/authorized_keys.
+adds it to \fI~x2gobroker/.ssh/authorized_keys\fR.
.PP
This command has to be executed once on each X2Go Server that is to become a member of a muli-node
X2Go server farm. The execution of this command requires root-privileges.
@@ -36,7 +36,7 @@ Display a help with all available command line options and exit.
.TP
\*(T<\fB\-b <BROKER_URL>, \-\-broker-url <BROKER_URL>\fR\*(T>
The URL of the X2Go Session Broker that we want to retrieve public keys from.
-The common pattern for this URL is http(s)://<broker_hostname>:<port>/pubkeys/, but may differ
+The common pattern for this URL is \fIhttp(s)://<broker_hostname>:<port>/pubkeys/\fR, but may differ
depending on your X2Go Session Broker setup.
.SH "FILES"
~x2gobroker/.ssh/authorized_keys
--
Alioth's /srv/git/_hooks_/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git
More information about the x2go-commits
mailing list