aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Gabriel <mike.gabriel@das-netzwerkteam.de>2015-02-09 14:23:12 +0100
committerMike Gabriel <mike.gabriel@das-netzwerkteam.de>2015-02-09 14:23:12 +0100
commit27ddd1695541ff333104d5a3e441a0c37308750e (patch)
treee4e79ede1689a3c9b641b33b3ff01eeac0f975e5
parenta0b2fd836883e8ec429d5f31779c61f31b1a204d (diff)
downloadnx-libs-27ddd1695541ff333104d5a3e441a0c37308750e.tar.gz
nx-libs-27ddd1695541ff333104d5a3e441a0c37308750e.tar.bz2
nx-libs-27ddd1695541ff333104d5a3e441a0c37308750e.zip
Work on man pages.
009_nxproxy_add-man-page.full+lite.patch 009_nxagent_add-man-page.full.patch 010_nxauth_fix-binary-name-in-man-page.full.patch
-rw-r--r--debian/patches/009_nxagent_add-man-page.full.patch43
-rw-r--r--debian/patches/009_nxproxy_add-man-page.full+lite.patch33
-rw-r--r--debian/patches/010_nxauth_fix-binary-name-in-man-page.full.patch119
-rw-r--r--debian/patches/series3
-rw-r--r--nx-X11/programs/Xserver/hw/nxagent/man/nxagent.137
-rw-r--r--nx-X11/programs/nxauth/nxauth.man42
-rw-r--r--nxproxy/man/nxproxy.127
7 files changed, 85 insertions, 219 deletions
diff --git a/debian/patches/009_nxagent_add-man-page.full.patch b/debian/patches/009_nxagent_add-man-page.full.patch
deleted file mode 100644
index cec8c7527..000000000
--- a/debian/patches/009_nxagent_add-man-page.full.patch
+++ /dev/null
@@ -1,43 +0,0 @@
-Description: man page for nxagent
-Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
-
---- /dev/null
-+++ b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
-@@ -0,0 +1,37 @@
-+.TH NXAGENT 1
-+.SH NAME
-+nxagent \- NoMachine's NX Agent.
-+.SH SYNOPSIS
-+.B nxagent
-+.I "[options]"
-+
-+.SH DESCRIPTION
-+\fBnxagent\fR is an Xnest-like X server for remote application/desktop access.
-+.PP
-+\fBnxagent\fR implements a very efficient compression of the X11 protocol.
-+.PP
-+This increases performance when using X applications over high latency and
-+low bandwidth networks, while providing a local (LAN-like) usage experience
-+even if connecting from off-site locations (via cable modem or GSM).
-+.PP
-+\fBnxagent\fR is not designed to be used as a standalone application.
-+It has to be launched on the server side by remote desktop frameworks like FreeNX.
-+.PP
-+Available clients are
-+NoMachine's \fBnxclient\fR or the community projects \fBqtnx\fR and \fBremmina\fR
-+(with NX plugin).
-+
-+.SH OPTIONS
-+.TP
-+.B \--help
-+Lists all others options that are not listed here.
-+
-+.SH FURTHER READINGS
-+Information on NX: http://www.nomachine.com
-+.PP
-+Information on FreeNX: http://freenx.berlios.de
-+
-+.SH AUTHOR
-+This manual page was written by Per Hansen <spamhans@yahoo.de>,
-+and modified by Marcelo Boveto Shima <marceloshima@gmail.com> and
-+Mike Gabriel <mike.gabriel@das-netzwerkteam.de>.
diff --git a/debian/patches/009_nxproxy_add-man-page.full+lite.patch b/debian/patches/009_nxproxy_add-man-page.full+lite.patch
deleted file mode 100644
index b60e218ee..000000000
--- a/debian/patches/009_nxproxy_add-man-page.full+lite.patch
+++ /dev/null
@@ -1,33 +0,0 @@
-Description: man page for nxproxy
-Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
-
---- /dev/null
-+++ b/nxproxy/man/nxproxy.1
-@@ -0,0 +1,27 @@
-+'\" -*- coding: utf-8 -*-
-+.if \n(.g .ds T< \\FC
-+.if \n(.g .ds T> \\F[\n[.fam]]
-+.de URL
-+\\$2 \(la\\$1\(ra\\$3
-+..
-+.if \n(.g .mso www.tmac
-+.TH nxproxy 1 "Nov 2011" "Version 3.5.0" "NX Proxy"
-+.SH NAME
-+nxproxy \- NX Proxy Tool
-+.SH SYNOPSIS
-+'nh
-+.fi
-+.ad l
-+\fBnxproxy\fR <options>
-+
-+.SH DESCRIPTION
-+\fBnxproxy\fR is a tool that allows one to tunnel X sessions through
-+the NX compression libraries. \fBnxproxy\fR is a backend application
-+utilized by the X2GoClient GUI and some other NX/X2Go clients.
-+.PP
-+.SH OPTIONS
-+For an insight in \fBnxproxy\fR options use \fBnxproxy \-\-help\fR on the command line.
-+.PP
-+.SH AUTHOR
-+This manual has been written by Mike Gabriel <mike.gabriel@das\-netzwerkteam.de> for the X2Go project
-+(http://www.x2go.org).
diff --git a/debian/patches/010_nxauth_fix-binary-name-in-man-page.full.patch b/debian/patches/010_nxauth_fix-binary-name-in-man-page.full.patch
deleted file mode 100644
index c8f76b51a..000000000
--- a/debian/patches/010_nxauth_fix-binary-name-in-man-page.full.patch
+++ /dev/null
@@ -1,119 +0,0 @@
-Description: Fix binary name in man page for nxauth.
- The NX auth man page in upstream still uses xauth as
- binary name.
-Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
-Last-Update: 2012-12-31
---- a/nx-X11/programs/nxauth/nxauth.man
-+++ b/nx-X11/programs/nxauth/nxauth.man
-@@ -27,51 +27,51 @@
- .\"
- .TH XAUTH 1 __xorgversion__
- .SH NAME
--xauth \- X authority file utility
-+nxauth \- NoMachine X authority file utility
- .SH SYNOPSIS
--.B xauth
-+.B nxauth
- [ \fB\-f\fP \fIauthfile\fP ] [ \fB\-vqib\fP ] [ \fIcommand arg ...\fP ]
- .SH DESCRIPTION
- .PP
--The \fIxauth\fP program is used to edit and display the authorization
-+The \fInxauth\fP program is used to edit and display the authorization
- information used in connecting to the X server. This program is usually
- used to extract authorization records from one machine and merge them in on
- another (as is the case when using remote logins or granting access to
- other users). Commands (described below) may be entered interactively,
--on the \fIxauth\fP command line, or in scripts. Note that this program
-+on the \fInxauth\fP command line, or in scripts. Note that this program
- does \fBnot\fP contact the X server except when the generate command is used.
--Normally \fIxauth\fP is not used to create the authority file entry in
-+Normally \fInxauth\fP is not used to create the authority file entry in
- the first place; \fIxdm\fP does that.
- .SH OPTIONS
--The following options may be used with \fIxauth\fP. They may be given
-+The following options may be used with \fInxauth\fP. They may be given
- individually (e.g., \fI\-q \-i\|\fP) or may combined (e.g., \fI\-qi\|\fP).
- .TP 8
- .B "\-f \fIauthfile\fP"
- This option specifies the name of the authority file to use. By default,
--\fIxauth\fP will use the file specified by the XAUTHORITY environment variable
-+\fInxauth\fP will use the file specified by the nxauthORITY environment variable
- or \fI\.Xauthority\fP in the user's home directory.
- .TP 8
- .B \-q
--This option indicates that \fIxauth\fP should operate quietly and not print
--unsolicited status messages. This is the default if an \fIxauth\fP command is
-+This option indicates that \fInxauth\fP should operate quietly and not print
-+unsolicited status messages. This is the default if an \fInxauth\fP command is
- is given on the command line or if the standard output is not directed to a
- terminal.
- .TP 8
- .B \-v
--This option indicates that \fIxauth\fP should operate verbosely and print
-+This option indicates that \fInxauth\fP should operate verbosely and print
- status messages indicating the results of various operations (e.g., how many
--records have been read in or written out). This is the default if \fIxauth\fP
-+records have been read in or written out). This is the default if \fInxauth\fP
- is reading commands from its standard input and its standard output is
- directed to a terminal.
- .TP 8
- .B \-i
--This option indicates that \fIxauth\fP should ignore any authority file
--locks. Normally, \fIxauth\fP will refuse to read or edit any authority files
-+This option indicates that \fInxauth\fP should ignore any authority file
-+locks. Normally, \fInxauth\fP will refuse to read or edit any authority files
- that have been locked by other programs (usually \fIxdm\fP or another
--\fIxauth\fP).
-+\fInxauth\fP).
- .TP 8
- .B \-b
--This option indicates that \fIxauth\fP should attempt to break any authority
-+This option indicates that \fInxauth\fP should attempt to break any authority
- file locks before proceeding. Use this option only to clean up stale locks.
- .SH COMMANDS
- The following commands may be used to manipulate authority files:
-@@ -157,14 +157,14 @@
- authority file.
- .TP 8
- .B "source \fIfilename"
--The specified file is treated as a script containing \fIxauth\fP commands
-+The specified file is treated as a script containing \fInxauth\fP commands
- to execute. Blank lines and lines beginning with a sharp sign (#) are
- ignored. A single dash may be used to indicate the standard input, if it
- hasn't already been read.
- .TP 8
- .B "info"
- Information describing the authorization file, whether or not any changes
--have been made, and from where \fIxauth\fP commands are being read
-+have been made, and from where \fInxauth\fP commands are being read
- is printed on the standard output.
- .TP 8
- .B "exit"
-@@ -194,12 +194,12 @@
- local entries for different machines may be stored in one authority file.
- .SH EXAMPLE
- .PP
--The most common use for \fIxauth\fP is to extract the entry for the
-+The most common use for \fInxauth\fP is to extract the entry for the
- current display, copy it to another machine, and merge it into the
- user's authority file on the remote machine:
- .sp
- .nf
-- % xauth extract \- $DISPLAY | rsh otherhost xauth merge \-
-+ % nxauth extract \- $DISPLAY | rsh otherhost nxauth merge \-
- .fi
- .PP
- .sp
-@@ -207,10 +207,10 @@
- authorization using the MIT-MAGIC-COOKIE-1 protocol. Clients that
- connect with this authorization will be untrusted.
- .nf
-- % xauth generate :0 .
-+ % nxauth generate :0 .
- .fi
- .SH ENVIRONMENT
--This \fIxauth\fP program uses the following environment variables:
-+This \fInxauth\fP program uses the following environment variables:
- .TP 8
- .B XAUTHORITY
- to get the name of the authority file to use if the \fI\-f\fP option isn't
diff --git a/debian/patches/series b/debian/patches/series
index 9f56169bf..8bbb69182 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,6 +1,3 @@
-009_nxproxy_add-man-page.full+lite.patch
-009_nxagent_add-man-page.full.patch
-010_nxauth_fix-binary-name-in-man-page.full.patch
012_nxcomp_makefile-uninstall+autoconf.full+lite.patch
013_nxcompext_makefile-uninstall+autoconf.full.patch
014_nxcompshad_makefile-uninstall+autoconf.full.patch
diff --git a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
new file mode 100644
index 000000000..198632312
--- /dev/null
+++ b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
@@ -0,0 +1,37 @@
+.TH NXAGENT 1
+.SH NAME
+nxagent \- NoMachine's NX Agent.
+.SH SYNOPSIS
+.B nxagent
+.I "[options]"
+
+.SH DESCRIPTION
+\fBnxagent\fR is an Xnest-like X server for remote application/desktop access.
+.PP
+\fBnxagent\fR implements a very efficient compression of the X11 protocol.
+.PP
+This increases performance when using X applications over high latency and
+low bandwidth networks, while providing a local (LAN-like) usage experience
+even if connecting from off-site locations (via cable modem or GSM).
+.PP
+\fBnxagent\fR is not designed to be used as a standalone application.
+It has to be launched on the server side by remote desktop frameworks like FreeNX.
+.PP
+Available clients are
+NoMachine's \fBnxclient\fR or the community projects \fBqtnx\fR and \fBremmina\fR
+(with NX plugin).
+
+.SH OPTIONS
+.TP
+.B \--help
+Lists all others options that are not listed here.
+
+.SH FURTHER READINGS
+Information on NX: http://www.nomachine.com
+.PP
+Information on FreeNX: http://freenx.berlios.de
+
+.SH AUTHOR
+This manual page was written by Per Hansen <spamhans@yahoo.de>,
+and modified by Marcelo Boveto Shima <marceloshima@gmail.com> and
+Mike Gabriel <mike.gabriel@das-netzwerkteam.de>.
diff --git a/nx-X11/programs/nxauth/nxauth.man b/nx-X11/programs/nxauth/nxauth.man
index a414afad4..b9df3737d 100644
--- a/nx-X11/programs/nxauth/nxauth.man
+++ b/nx-X11/programs/nxauth/nxauth.man
@@ -27,51 +27,51 @@
.\"
.TH XAUTH 1 __xorgversion__
.SH NAME
-xauth \- X authority file utility
+nxauth \- NoMachine X authority file utility
.SH SYNOPSIS
-.B xauth
+.B nxauth
[ \fB\-f\fP \fIauthfile\fP ] [ \fB\-vqib\fP ] [ \fIcommand arg ...\fP ]
.SH DESCRIPTION
.PP
-The \fIxauth\fP program is used to edit and display the authorization
+The \fInxauth\fP program is used to edit and display the authorization
information used in connecting to the X server. This program is usually
used to extract authorization records from one machine and merge them in on
another (as is the case when using remote logins or granting access to
other users). Commands (described below) may be entered interactively,
-on the \fIxauth\fP command line, or in scripts. Note that this program
+on the \fInxauth\fP command line, or in scripts. Note that this program
does \fBnot\fP contact the X server except when the generate command is used.
-Normally \fIxauth\fP is not used to create the authority file entry in
+Normally \fInxauth\fP is not used to create the authority file entry in
the first place; \fIxdm\fP does that.
.SH OPTIONS
-The following options may be used with \fIxauth\fP. They may be given
+The following options may be used with \fInxauth\fP. They may be given
individually (e.g., \fI\-q \-i\|\fP) or may combined (e.g., \fI\-qi\|\fP).
.TP 8
.B "\-f \fIauthfile\fP"
This option specifies the name of the authority file to use. By default,
-\fIxauth\fP will use the file specified by the XAUTHORITY environment variable
+\fInxauth\fP will use the file specified by the nxauthORITY environment variable
or \fI\.Xauthority\fP in the user's home directory.
.TP 8
.B \-q
-This option indicates that \fIxauth\fP should operate quietly and not print
-unsolicited status messages. This is the default if an \fIxauth\fP command is
+This option indicates that \fInxauth\fP should operate quietly and not print
+unsolicited status messages. This is the default if an \fInxauth\fP command is
is given on the command line or if the standard output is not directed to a
terminal.
.TP 8
.B \-v
-This option indicates that \fIxauth\fP should operate verbosely and print
+This option indicates that \fInxauth\fP should operate verbosely and print
status messages indicating the results of various operations (e.g., how many
-records have been read in or written out). This is the default if \fIxauth\fP
+records have been read in or written out). This is the default if \fInxauth\fP
is reading commands from its standard input and its standard output is
directed to a terminal.
.TP 8
.B \-i
-This option indicates that \fIxauth\fP should ignore any authority file
-locks. Normally, \fIxauth\fP will refuse to read or edit any authority files
+This option indicates that \fInxauth\fP should ignore any authority file
+locks. Normally, \fInxauth\fP will refuse to read or edit any authority files
that have been locked by other programs (usually \fIxdm\fP or another
-\fIxauth\fP).
+\fInxauth\fP).
.TP 8
.B \-b
-This option indicates that \fIxauth\fP should attempt to break any authority
+This option indicates that \fInxauth\fP should attempt to break any authority
file locks before proceeding. Use this option only to clean up stale locks.
.SH COMMANDS
The following commands may be used to manipulate authority files:
@@ -157,14 +157,14 @@ Authorization entries matching the specified displays are removed from the
authority file.
.TP 8
.B "source \fIfilename"
-The specified file is treated as a script containing \fIxauth\fP commands
+The specified file is treated as a script containing \fInxauth\fP commands
to execute. Blank lines and lines beginning with a sharp sign (#) are
ignored. A single dash may be used to indicate the standard input, if it
hasn't already been read.
.TP 8
.B "info"
Information describing the authorization file, whether or not any changes
-have been made, and from where \fIxauth\fP commands are being read
+have been made, and from where \fInxauth\fP commands are being read
is printed on the standard output.
.TP 8
.B "exit"
@@ -194,12 +194,12 @@ referred to as \fIhostname\fP/unix:\fIdisplaynumber\fP so that
local entries for different machines may be stored in one authority file.
.SH EXAMPLE
.PP
-The most common use for \fIxauth\fP is to extract the entry for the
+The most common use for \fInxauth\fP is to extract the entry for the
current display, copy it to another machine, and merge it into the
user's authority file on the remote machine:
.sp
.nf
- % xauth extract \- $DISPLAY | rsh otherhost xauth merge \-
+ % nxauth extract \- $DISPLAY | rsh otherhost nxauth merge \-
.fi
.PP
.sp
@@ -207,10 +207,10 @@ The following command contacts the server :0 to create an
authorization using the MIT-MAGIC-COOKIE-1 protocol. Clients that
connect with this authorization will be untrusted.
.nf
- % xauth generate :0 .
+ % nxauth generate :0 .
.fi
.SH ENVIRONMENT
-This \fIxauth\fP program uses the following environment variables:
+This \fInxauth\fP program uses the following environment variables:
.TP 8
.B XAUTHORITY
to get the name of the authority file to use if the \fI\-f\fP option isn't
diff --git a/nxproxy/man/nxproxy.1 b/nxproxy/man/nxproxy.1
new file mode 100644
index 000000000..0432380f8
--- /dev/null
+++ b/nxproxy/man/nxproxy.1
@@ -0,0 +1,27 @@
+'\" -*- coding: utf-8 -*-
+.if \n(.g .ds T< \\FC
+.if \n(.g .ds T> \\F[\n[.fam]]
+.de URL
+\\$2 \(la\\$1\(ra\\$3
+..
+.if \n(.g .mso www.tmac
+.TH nxproxy 1 "Nov 2011" "Version 3.5.0" "NX Proxy"
+.SH NAME
+nxproxy \- NX Proxy Tool
+.SH SYNOPSIS
+'nh
+.fi
+.ad l
+\fBnxproxy\fR <options>
+
+.SH DESCRIPTION
+\fBnxproxy\fR is a tool that allows one to tunnel X sessions through
+the NX compression libraries. \fBnxproxy\fR is a backend application
+utilized by the X2GoClient GUI and some other NX/X2Go clients.
+.PP
+.SH OPTIONS
+For an insight in \fBnxproxy\fR options use \fBnxproxy \-\-help\fR on the command line.
+.PP
+.SH AUTHOR
+This manual has been written by Mike Gabriel <mike.gabriel@das\-netzwerkteam.de> for the X2Go project
+(http://www.x2go.org).