← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/rxvt-unicode/jaunty-proposed

« back to all changes in this revision

Viewing changes to doc/rxvtd.1.pod

  • Committer: Bazaar Package Importer
  • Author(s): Decklin Foster
  • Date: 2006-09-01 14:44:58 UTC
  • mfrom: (1.2.1 upstream) (9 edgy)
  • mto: (3.2.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 10.
  • Revision ID: james.westby@ubuntu.com-20060901144458-3jn5sjka9gpg0v9i
http://bugs.debian.org/385481
* Edit the comments in the app-defaults file, and disable all settings by
  default. If font autoselection fails, I would prefer to open a new bug
  specifically for that. (Closes: #385481)
* Reorganize and edit README.Debian, pushing as much as possible into FAQ
  format (with resource setting issues first).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rxvtd.1.pod
 
1
=head1 NAME
 
2
 
 
3
@@RXVT_NAME@@d - @@RXVT_NAME@@ terminal daemon
 
4
 
 
5
=head1 SYNOPSIS
 
6
 
 
7
B<@@RXVT_NAME@@d> [-q|--quiet] [-o|--opendisplay] [-f|--fork]
 
8
 
 
9
=head1 DESCRIPTION
 
10
 
 
11
This manpage describes the @@RXVT_NAME@@d daemon, which is the same vt102
 
12
terminal emulator as @@RXVT_NAME@@, but runs as a daemon that can open
 
13
multiple terminal windows within the same process.
 
14
 
 
15
You can run it from your X startup scripts, for example, although it is
 
16
not dependent on a working DISPLAY and, in fact, can open windows on
 
17
multiple X displays on the same time.
 
18
 
 
19
Advantages of running a @@RXVT_NAME@@ daemon include faster creation time
 
20
for terminal windows and a lot of saved memory.
 
21
 
 
22
The disadvantage is a possible impact on stability - if the
 
23
main program crashes, all processes in the terminal windows are
 
24
terminated. For example, as there is no way to cleanly react to abnormal
 
25
connection closes, C<xkill> and server resets/restarts will kill the
 
26
B<@@RXVT_NAME@@d> instance including all windows it has opened.
 
27
 
 
28
=head1 OPTIONS
 
29
 
 
30
B<@@RXVT_NAME@@d> currently understands a few options only. Bundling of
 
31
options is not yet supported.
 
32
 
 
33
=over 4
 
34
 
 
35
=item B<-q>, B<--quiet>
 
36
 
 
37
Normally, B<@@RXVT_NAME@@d> outputs the message C<< rxvt-unicode daemon
 
38
listening on <path> >> after binding to its control socket. This option
 
39
will suppress this message (errors and warnings will still be logged).
 
40
 
 
41
=item B<-o>, B<--opendisplay>
 
42
 
 
43
This forces B<@@RXVT_NAME@@d> to open a connection to the current
 
44
C<$DISPLAY> and keep it open.
 
45
 
 
46
This is useful if you want to bind an instance of B<@@RXVT_NAME@@d> to
 
47
the lifetime of a specific display/server. If the server does a reset,
 
48
B<@@RXVT_NAME@@d> will be killed automatically.
 
49
 
 
50
=item B<-f>, B<--fork>
 
51
 
 
52
This makes B<@@RXVT_NAME@@d> fork after it has bound itself to its control
 
53
socket.
 
54
 
 
55
=back
 
56
 
 
57
=head1 EXAMPLES
 
58
 
 
59
This is a useful invocation of B<@@RXVT_NAME@@d> in a F<.xsession>-style
 
60
script:
 
61
 
 
62
   B<@@RXVT_NAME@@d> -q -f -o
 
63
 
 
64
This waits till the control socket is available, opens the current display
 
65
and forks into the background. When you log-out, the server is reset and
 
66
B<@@RXVT_NAME@@d> is killed.
 
67
 
 
68
=head1 ENVIRONMENT
 
69
 
 
70
=over 4
 
71
 
 
72
=item B<RXVT_SOCKET>
 
73
 
 
74
Both B<@@RXVT_NAME@@c> and B<@@RXVT_NAME@@d> use the environment
 
75
variable F<RXVT_SOCKET> to create a listening socket and to contact
 
76
the @@RXVT_NAME@@d, respectively. If the variable is missing,
 
77
F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>> is used. The variable must
 
78
specify the absolute path of the socket to create.
 
79
 
 
80
=item B<DISPLAY>
 
81
 
 
82
Only used when the C<--opendisplay> option is specified. Must contain a
 
83
valid X display name.
 
84
 
 
85
=over
 
86
 
 
87
=head1 SEE ALSO
 
88
 
 
89
@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1)