diff options
author | Jim Ramsay <i.am@jimramsay.com> | 2009-02-18 01:52:35 (GMT) |
---|---|---|
committer | Jim Ramsay <i.am@jimramsay.com> | 2009-05-26 20:16:06 (GMT) |
commit | 6beb1f96b25cd4ce23395d6666aa8ea22038817e (patch) | |
tree | f7b764e1b7220b75cecb35dece73e31a4b33db6e /doc/fluxbox-remote.1.in | |
parent | bd8275b33cec5b0765b93e8905bfefcdfd994b73 (diff) | |
download | fluxbox_lack-6beb1f96b25cd4ce23395d6666aa8ea22038817e.zip fluxbox_lack-6beb1f96b25cd4ce23395d6666aa8ea22038817e.tar.bz2 |
Process all asciidoc-generated man pages with sed
This makes things a bit simpler and more generic.
Diffstat (limited to 'doc/fluxbox-remote.1.in')
-rw-r--r-- | doc/fluxbox-remote.1.in | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/doc/fluxbox-remote.1.in b/doc/fluxbox-remote.1.in new file mode 100644 index 0000000..b27e30f --- /dev/null +++ b/doc/fluxbox-remote.1.in | |||
@@ -0,0 +1,195 @@ | |||
1 | .\" Title: fluxbox-remote | ||
2 | .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] | ||
3 | .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> | ||
4 | .\" Date: 02/10/2009 | ||
5 | .\" Manual: Fluxbox Manual | ||
6 | .\" Source: fluxbox-remote.txt 1.1.1 | ||
7 | .\" Language: English | ||
8 | .\" | ||
9 | .TH "FLUXBOX\-REMOTE" "1" "02/10/2009" "fluxbox\-remote\&.txt 1\&.1\&." "Fluxbox Manual" | ||
10 | .\" ----------------------------------------------------------------- | ||
11 | .\" * (re)Define some macros | ||
12 | .\" ----------------------------------------------------------------- | ||
13 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
14 | .\" toupper - uppercase a string (locale-aware) | ||
15 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
16 | .de toupper | ||
17 | .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ | ||
18 | \\$* | ||
19 | .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz | ||
20 | .. | ||
21 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
22 | .\" SH-xref - format a cross-reference to an SH section | ||
23 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
24 | .de SH-xref | ||
25 | .ie n \{\ | ||
26 | .\} | ||
27 | .toupper \\$* | ||
28 | .el \{\ | ||
29 | \\$* | ||
30 | .\} | ||
31 | .. | ||
32 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
33 | .\" SH - level-one heading that works better for non-TTY output | ||
34 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
35 | .de1 SH | ||
36 | .\" put an extra blank line of space above the head in non-TTY output | ||
37 | .if t \{\ | ||
38 | .sp 1 | ||
39 | .\} | ||
40 | .sp \\n[PD]u | ||
41 | .nr an-level 1 | ||
42 | .set-an-margin | ||
43 | .nr an-prevailing-indent \\n[IN] | ||
44 | .fi | ||
45 | .in \\n[an-margin]u | ||
46 | .ti 0 | ||
47 | .HTML-TAG ".NH \\n[an-level]" | ||
48 | .it 1 an-trap | ||
49 | .nr an-no-space-flag 1 | ||
50 | .nr an-break-flag 1 | ||
51 | \." make the size of the head bigger | ||
52 | .ps +3 | ||
53 | .ft B | ||
54 | .ne (2v + 1u) | ||
55 | .ie n \{\ | ||
56 | .\" if n (TTY output), use uppercase | ||
57 | .toupper \\$* | ||
58 | .\} | ||
59 | .el \{\ | ||
60 | .nr an-break-flag 0 | ||
61 | .\" if not n (not TTY), use normal case (not uppercase) | ||
62 | \\$1 | ||
63 | .in \\n[an-margin]u | ||
64 | .ti 0 | ||
65 | .\" if not n (not TTY), put a border/line under subheading | ||
66 | .sp -.6 | ||
67 | \l'\n(.lu' | ||
68 | .\} | ||
69 | .. | ||
70 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
71 | .\" SS - level-two heading that works better for non-TTY output | ||
72 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
73 | .de1 SS | ||
74 | .sp \\n[PD]u | ||
75 | .nr an-level 1 | ||
76 | .set-an-margin | ||
77 | .nr an-prevailing-indent \\n[IN] | ||
78 | .fi | ||
79 | .in \\n[IN]u | ||
80 | .ti \\n[SN]u | ||
81 | .it 1 an-trap | ||
82 | .nr an-no-space-flag 1 | ||
83 | .nr an-break-flag 1 | ||
84 | .ps \\n[PS-SS]u | ||
85 | \." make the size of the head bigger | ||
86 | .ps +2 | ||
87 | .ft B | ||
88 | .ne (2v + 1u) | ||
89 | .if \\n[.$] \&\\$* | ||
90 | .. | ||
91 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
92 | .\" BB/BE - put background/screen (filled box) around block of text | ||
93 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
94 | .de BB | ||
95 | .if t \{\ | ||
96 | .sp -.5 | ||
97 | .br | ||
98 | .in +2n | ||
99 | .ll -2n | ||
100 | .gcolor red | ||
101 | .di BX | ||
102 | .\} | ||
103 | .. | ||
104 | .de EB | ||
105 | .if t \{\ | ||
106 | .if "\\$2"adjust-for-leading-newline" \{\ | ||
107 | .sp -1 | ||
108 | .\} | ||
109 | .br | ||
110 | .di | ||
111 | .in | ||
112 | .ll | ||
113 | .gcolor | ||
114 | .nr BW \\n(.lu-\\n(.i | ||
115 | .nr BH \\n(dn+.5v | ||
116 | .ne \\n(BHu+.5v | ||
117 | .ie "\\$2"adjust-for-leading-newline" \{\ | ||
118 | \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] | ||
119 | .\} | ||
120 | .el \{\ | ||
121 | \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] | ||
122 | .\} | ||
123 | .in 0 | ||
124 | .sp -.5v | ||
125 | .nf | ||
126 | .BX | ||
127 | .in | ||
128 | .sp .5v | ||
129 | .fi | ||
130 | .\} | ||
131 | .. | ||
132 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
133 | .\" BM/EM - put colored marker in margin next to block of text | ||
134 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
135 | .de BM | ||
136 | .if t \{\ | ||
137 | .br | ||
138 | .ll -2n | ||
139 | .gcolor red | ||
140 | .di BX | ||
141 | .\} | ||
142 | .. | ||
143 | .de EM | ||
144 | .if t \{\ | ||
145 | .br | ||
146 | .di | ||
147 | .ll | ||
148 | .gcolor | ||
149 | .nr BH \\n(dn | ||
150 | .ne \\n(BHu | ||
151 | \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] | ||
152 | .in 0 | ||
153 | .nf | ||
154 | .BX | ||
155 | .in | ||
156 | .fi | ||
157 | .\} | ||
158 | .. | ||
159 | .\" ----------------------------------------------------------------- | ||
160 | .\" * set default formatting | ||
161 | .\" ----------------------------------------------------------------- | ||
162 | .\" disable hyphenation | ||
163 | .nh | ||
164 | .\" disable justification (adjust text to left margin only) | ||
165 | .ad l | ||
166 | .\" ----------------------------------------------------------------- | ||
167 | .\" * MAIN CONTENT STARTS HERE * | ||
168 | .\" ----------------------------------------------------------------- | ||
169 | .SH "Name" | ||
170 | fluxbox-remote \- command line access to key commands for fluxbox(1) | ||
171 | .SH "Synopsis" | ||
172 | .sp | ||
173 | \fBfluxbox\-remote\fR \fIcommand\fR | ||
174 | .SH "DESCRIPTION" | ||
175 | .sp | ||
176 | \fIfluxbox\-remote(1)\fR is designed to allow scripts to execute most key commands from \fIfluxbox(1)\fR\&. \fIfluxbox\-remote(1)\fR will only work with \fIfluxbox(1)\fR: its communications with \fIfluxbox(1)\fR are not standardized in any way\&. It is recommended that a standards\-based tool such as \fIwmctrl(1)\fR be used whenever possible, in order for scripts to work with other window managers\&. | ||
177 | .SH "CAVEATS" | ||
178 | .sp | ||
179 | \fIfluxbox\-remote(1)\fR uses the X11 protocol to communicate with \fIfluxbox(1)\fR\&. Therefore, it is possible for any user with access to the \fIX(7)\fR server to use \fIfluxbox\-remote(1)\fR\&. For this reason, several key commands have been disabled\&. Users should be aware of the security implications when enabling \fIfluxbox\-remote(1)\fR, especially when using a forwarded \fIX(7)\fR connection\&. | ||
180 | .SH "RESOURCES" | ||
181 | .PP | ||
182 | session\&.screen0\&.allowRemoteActions: <boolean> | ||
183 | .RS 4 | ||
184 | This resource in ~/\&.fluxbox/init must be set to `true\' in order for | ||
185 | \fIfluxbox\-remote(1)\fR | ||
186 | to function\&. Please read the | ||
187 | \fBCAVEATS\fR | ||
188 | first\&. | ||
189 | .RE | ||
190 | .SH "ENVIRONMENT" | ||
191 | .sp | ||
192 | In order to communicate with \fIfluxbox(1)\fR, the DISPLAY environment variable must be set properly\&. Usually, the value should be `:0\&.0\'\&. | ||
193 | .SH "SEE ALSO" | ||
194 | .sp | ||
195 | fluxbox(1), fluxbox\-keys(5), wmctrl(1) | ||