summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorGaetan Nadon <memsize@videotron.ca>2011-01-19 10:06:55 -0500
committerGaetan Nadon <memsize@videotron.ca>2011-01-19 10:06:55 -0500
commit3bb9256b8e3a56b94281ea787c07f080c0a80312 (patch)
tree64629aac758408c38144b2e64d229310ee7e64c1 /man
parentf9d0aa7ca56c68aee0ba53a9ad9c232c544264b0 (diff)
config: move man pages into their own directory
Use services provided by XORG_MANPAGE_SECTIONS. Use standard Makefile for man pages. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am22
-rw-r--r--man/filenames.sed.c29
-rw-r--r--man/sessreg.man135
3 files changed, 186 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..d200a94
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,22 @@
+
+appmandir = $(APP_MAN_DIR)
+appman_PRE = sessreg.man
+appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))
+
+EXTRA_DIST = $(appman_PRE) filenames.sed.c
+CLEANFILES = $(appman_DATA) filenames.sed
+SUFFIXES = .$(APP_MAN_SUFFIX) .man
+
+AM_CPPFLAGS = -I..
+filenames.sed: filenames.sed.c
+ $(AM_V_GEN)$(CPP) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) \
+ $(AM_CPPFLAGS) $(CPPFLAGS) $(srcdir)/filenames.sed.c | \
+ grep 's|__' > $@
+
+# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
+MAN_SUBSTS += -f filenames.sed
+
+sessreg.$(APP_MAN_SUFFIX): filenames.sed
+
+.man.$(APP_MAN_SUFFIX):
+ $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
diff --git a/man/filenames.sed.c b/man/filenames.sed.c
new file mode 100644
index 0000000..2db7845
--- /dev/null
+++ b/man/filenames.sed.c
@@ -0,0 +1,29 @@
+#include "sessreg.h"
+
+#ifdef UTMPX_FILE
+# define UTF UTMPX_FILE
+# define UTM utmpx
+#else
+# define UTF UTMP_FILE
+# define UTM utmp
+#endif
+
+#ifdef WTMPX_FILE
+# define WTF WTMPX_FILE
+#else
+# define WTF WTMP_FILE
+#endif
+
+#ifndef TTYS_FILE
+# define TTYS_FILE "/etc/ttys"
+#endif
+
+#ifndef LLOG_FILE
+# define LLOG_FILE "/var/log/lastlog"
+#endif
+
+s|__utmp_manpage__|UTM|g
+s|__utmp_file__|UTF|g
+s|__wtmp_file__|WTF|g
+s|__ttys_file__|TTYS_FILE|g
+s|__lastlog_file__|LLOG_FILE|g
diff --git a/man/sessreg.man b/man/sessreg.man
new file mode 100644
index 0000000..bb1d9c8
--- /dev/null
+++ b/man/sessreg.man
@@ -0,0 +1,135 @@
+.\" $Xorg: sessreg.man,v 1.4 2001/02/09 02:05:40 xorgcvs Exp $
+.\" Copyright 1994, 1998 The Open Group
+.\"
+.\" Permission to use, copy, modify, distribute, and sell this software and its
+.\" documentation for any purpose is hereby granted without fee, provided that
+.\" the above copyright notice appear in all copies and that both that
+.\" copyright notice and this permission notice appear in supporting
+.\" documentation.
+.\"
+.\" The above copyright notice and this permission notice shall be included
+.\" in all copies or substantial portions of the Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
+.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+.\" OTHER DEALINGS IN THE SOFTWARE.
+.\"
+.\" Except as contained in this notice, the name of The Open Group shall
+.\" not be used in advertising or otherwise to promote the sale, use or
+.\" other dealings in this Software without prior written authorization
+.\" from The Open Group.
+.\"
+.\" $XFree86: xc/programs/xdm/sessreg.man,v 1.7 2001/04/23 20:31:09 dawes Exp $
+.\"
+.TH SESSREG __appmansuffix__ __xorgversion__
+.SH NAME
+sessreg \- manage utmp/wtmp entries for non-init clients
+.SH SYNOPSIS
+.B sessreg
+[-w \fIwtmp-file\fP]
+[-u \fIutmp-file\fP]
+[-L \fIlastlog-file\fP]
+[-l \fIline-name\fP]
+[-h \fIhost-name\fP]
+[-s \fIslot-number\fP]
+[-x \fIXservers-file\fP]
+[-t \fIttys-file\fP]
+[-a]
+[-d]
+\fIuser-name\fP
+.SH DESCRIPTION
+.PP
+\fISessreg\fP is a simple program for managing utmp/wtmp and lastlog
+entries for xdm sessions.
+.PP
+System V has a better interface to utmp than BSD; it
+dynamically allocates entries in the file, instead of writing them at fixed
+positions indexed by position in
+.BR __ttys_file__ .
+.PP
+To manage BSD-style utmp files, \fIsessreg\fP has two strategies. In
+conjunction with xdm, the -x option counts the number of lines in
+.B __ttys_file__
+and then adds to that the number of the line in the Xservers file which
+specifies the display. The display name must be specified as the
+"line-name" using the -l option. This sum is used as the "slot-number" in
+the utmp file that this entry will be written at. In the more general case,
+the -s option specifies the slot-number directly. If for some strange reason
+your system uses a file other than
+.B __ttys_file__
+to manage init, the -t option can direct
+\fIsessreg\fP to look elsewhere for a count of terminal sessions.
+.PP
+Conversely, System V managers will not ever need to use these options (-x,
+-s and -t). To make the program easier to document and explain,
+\fIsessreg\fP accepts the BSD-specific flags in the System V
+environment and ignores them.
+.PP
+BSD and Linux also have a host-name field in the utmp file which doesn't
+exist in System V. This option is also ignored by the System V version of
+\fIsessreg\fP.
+.SH USAGE
+.PP
+In Xstartup, place a call like:
+.nf
+
+ sessreg -a -l $DISPLAY -x /etc/X11/xdm/Xservers $USER
+
+.fi
+and in Xreset:
+.nf
+
+ sessreg -d -l $DISPLAY -x /etc/X11/xdm/Xservers $USER
+.fi
+.SH OPTIONS
+.IP "\fB-w\fP \fIwtmp-file\fP"
+This specifies an alternate wtmp file, instead of
+.BR __wtmp_file__ .
+The special name "none" disables writing records to the wtmp file.
+.IP "\fB-u\fP \fIutmp-file\fP"
+This specifies an alternate utmp file, instead of
+.BR __utmp_file__ .
+The special name "none" disables writing records to the utmp file.
+.IP "\fB-L\fP \fIlastlog-file\fP"
+This specifies an alternate lastlog file, instead of
+.BR __lastlog_file__ ,
+if the platform supports lastlog files.
+The special name "none" disables writing records to the lastlog file.
+.IP "\fB-l\fP \fIline-name\fP"
+This describes the "line" name of the entry. For terminal sessions,
+this is the final pathname segment of the terminal device filename
+(e.g. ttyd0). For X sessions, it should probably be the local display name
+given to the users session (e.g. :0). If none is specified, the
+terminal name will be determined with ttyname(__libmansuffix__) and stripped of leading
+components.
+.IP "\fB-h\fP \fIhost-name\fP"
+This is set for BSD hosts to indicate that the session was initiated from
+a remote host. In typical xdm usage, this options is not used.
+.IP "\fB-s\fP \fIslot-number\fP"
+Each potential session has a unique slot number in BSD systems, most are
+identified by the position of the \fIline-name\fP in the
+.BR __ttys_file__ file.
+This option overrides the default position determined with ttyslot(__libmansuffix__).
+This option is inappropriate for use with xdm, the -x option is more useful.
+.IP "\fB-x\fP \fIXservers-file\fP"
+As X sessions are one-per-display, and each display is entered in this file,
+this options sets the \fIslot-number\fP to be the number of lines in
+the \fIttys-file\fP plus the index into this file that the \fIline-name\fP
+is found.
+.IP "\fB-t\fP \fIttys-file\fP"
+This specifies an alternate file which the \fI-x\fP option will use to count
+the number of terminal sessions on a host.
+.IP "\fB-a\fP"
+This session should be added to utmp/wtmp.
+.IP "\fB-d\fP"
+This session should be deleted from utmp/wtmp. One of -a/-d must
+be specified.
+.SH "SEE ALSO"
+.BR xdm (__appmansuffix__),
+.BR __utmp_manpage__ (__filemansuffix__)
+.SH AUTHOR
+Keith Packard, MIT X Consortium