doc/rxvtd.1.man.in

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "@@RXVT_NAME@@ 1"
 127 .TH @@RXVT_NAME@@ 1 "2009-12-30" "@@RXVT_VERSION@@" "RXVT-UNICODE"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 @@RXVT_NAME@@d \- @@RXVT_NAME@@ terminal daemon
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork] [\-m|\-\-mlock]
 137 .PP
 138 \&\fB@@RXVT_NAME@@d\fR \-q \-o \-f    # for .xsession use
 139 .SH "DESCRIPTION"
 140 .IX Header "DESCRIPTION"
 141 This manpage describes the @@RXVT_NAME@@d daemon, which is the same vt102
 142 terminal emulator as @@RXVT_NAME@@, but runs as a daemon that can open
 143 multiple terminal windows within the same process.
 144 .PP
 145 You can run it from your X startup scripts, for example, although it is
 146 not dependent on a working \s-1DISPLAY\s0 and, in fact, can open windows on
 147 multiple X displays on the same time.
 148 .PP
 149 Advantages of running a @@RXVT_NAME@@ daemon include faster creation time
 150 for terminal windows and a lot of saved memory.
 151 .PP
 152 The disadvantage is a possible impact on stability \- if the
 153 main program crashes, all processes in the terminal windows are
 154 terminated. For example, as there is no way to cleanly react to abnormal
 155 connection closes, \f(CW\*(C`xkill\*(C'\fR and server resets/restarts will kill the
 156 \&\fB@@RXVT_NAME@@d\fR instance including all windows it has opened.
 157 .SH "OPTIONS"
 158 .IX Header "OPTIONS"
 159 \&\fB@@RXVT_NAME@@d\fR currently understands a few options only. Bundling of
 160 options is not yet supported.
 161 .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
 162 .IX Item "-q, --quiet"
 163 Normally, \fB@@RXVT_NAME@@d\fR outputs the message \f(CW\*(C`rxvt\-unicode daemon
 164 listening on <path>\*(C'\fR after binding to its control socket. This option
 165 will suppress this message (errors and warnings will still be logged).
 166 .IP "\fB\-o\fR, \fB\-\-opendisplay\fR" 4
 167 .IX Item "-o, --opendisplay"
 168 This forces \fB@@RXVT_NAME@@d\fR to open a connection to the current
 169 \&\f(CW$DISPLAY\fR and keep it open.
 170 .Sp
 171 This is useful if you want to bind an instance of \fB@@RXVT_NAME@@d\fR to
 172 the lifetime of a specific display/server. If the server does a reset,
 173 \&\fB@@RXVT_NAME@@d\fR will be killed automatically.
 174 .IP "\fB\-f\fR, \fB\-\-fork\fR" 4
 175 .IX Item "-f, --fork"
 176 This makes \fB@@RXVT_NAME@@d\fR fork after it has bound itself to its control
 177 socket.
 178 .IP "\fB\-m\fR, \fB\-\-mlock\fR" 4
 179 .IX Item "-m, --mlock"
 180 This makes \fB@@RXVT_NAME@@d\fR call \fImlockall\fR\|(2) on itself. This locks
 181 \&\fB@@RXVT_NAME@@d\fR in \s-1RAM\s0 and prevents it from being swapped out to disk,
 182 at the cost of consuming a lot more memory on most operating systems.
 183 .Sp
 184 Note: In order to use this feature, your system administrator must have set
 185 your user's \s-1RLIMIT_MEMLOCK\s0 to a size greater than or equal to the size of the
 186 \&\fB@@RXVT_NAME@@d\fR binary (or to unlimited). See \fI/etc/security/limits.conf\fR.
 187 .Sp
 188 Note 2: There is a known bug in glibc (possibly fixed in 2.8 and later
 189 versions) where calloc returns non-zeroed memory when mlockall is in
 190 effect. If you experience crashes or other odd behaviour while using
 191 \&\-\-mlock, try it without it.
 192 .SH "EXAMPLES"
 193 .IX Header "EXAMPLES"
 194 This is a useful invocation of \fB@@RXVT_NAME@@d\fR in a \fI.xsession\fR\-style
 195 script:
 196 .PP
 197 .Vb 1
 198 \&   @@RXVT_NAME@@d \-q \-f \-o
 199 .Ve
 200 .PP
 201 This waits till the control socket is available, opens the current display
 202 and forks into the background. When you log-out, the server is reset and
 203 \&\fB@@RXVT_NAME@@d\fR is killed.
 204 .SH "ENVIRONMENT"
 205 .IX Header "ENVIRONMENT"
 206 .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
 207 .IX Item "RXVT_SOCKET"
 208 Both \fB@@RXVT_NAME@@c\fR and \fB@@RXVT_NAME@@d\fR use the environment
 209 variable \fI\s-1RXVT_SOCKET\s0\fR to create a listening socket and to contact
 210 the @@RXVT_NAME@@d, respectively. If the variable is missing then
 211 \&\fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename>\fI\fR is used.
 212 .IP "\fB\s-1DISPLAY\s0\fR" 4
 213 .IX Item "DISPLAY"
 214 Only used when the \f(CW\*(C`\-\-opendisplay\*(C'\fR option is specified. Must contain a
 215 valid X display name.
 216 .SH "SEE ALSO"
 217 .IX Header "SEE ALSO"
 218 @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1)