9.07

[dana/urxvt.git] / doc / rxvtd.1.man.in

diff --git a/doc/rxvtd.1.man.in b/doc/rxvtd.1.man.in
index b825e3b..45e91bc 100644 (file)
--- a/doc/rxvtd.1.man.in
+++ b/doc/rxvtd.1.man.in
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
@@ -53,7 +45,7 @@
 .el       .ds Aq '
 .\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .ie \nF \{\
@@ -132,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "@@RXVT_NAME@@ 1"
-.TH @@RXVT_NAME@@ 1 "2008-06-15" "@@RXVT_VERSION@@" "RXVT-UNICODE"
+.TH @@RXVT_NAME@@ 1 "2009-12-30" "@@RXVT_VERSION@@" "RXVT-UNICODE"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -141,7 +133,7 @@
 @@RXVT_NAME@@d \- @@RXVT_NAME@@ terminal daemon
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork]
+\&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork] [\-m|\-\-mlock]
 .PP
 \&\fB@@RXVT_NAME@@d\fR \-q \-o \-f    # for .xsession use
 .SH "DESCRIPTION"
@@ -183,6 +175,20 @@ the lifetime of a specific display/server. If the server does a reset,
 .IX Item "-f, --fork"
 This makes \fB@@RXVT_NAME@@d\fR fork after it has bound itself to its control
 socket.
+.IP "\fB\-m\fR, \fB\-\-mlock\fR" 4
+.IX Item "-m, --mlock"
+This makes \fB@@RXVT_NAME@@d\fR call \fImlockall\fR\|(2) on itself. This locks
+\&\fB@@RXVT_NAME@@d\fR in \s-1RAM\s0 and prevents it from being swapped out to disk,
+at the cost of consuming a lot more memory on most operating systems.
+.Sp
+Note: In order to use this feature, your system administrator must have set
+your user's \s-1RLIMIT_MEMLOCK\s0 to a size greater than or equal to the size of the
+\&\fB@@RXVT_NAME@@d\fR binary (or to unlimited). See \fI/etc/security/limits.conf\fR.
+.Sp
+Note 2: There is a known bug in glibc (possibly fixed in 2.8 and later
+versions) where calloc returns non-zeroed memory when mlockall is in
+effect. If you experience crashes or other odd behaviour while using
+\&\-\-mlock, try it without it.
 .SH "EXAMPLES"
 .IX Header "EXAMPLES"
 This is a useful invocation of \fB@@RXVT_NAME@@d\fR in a \fI.xsession\fR\-style