diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/asciidoc/fluxbox-remote.txt | 40 | ||||
-rw-r--r-- | doc/fluxbox-remote.1 | 39 |
3 files changed, 80 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index ad34dad..afc6040 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am | |||
@@ -5,7 +5,7 @@ SUBDIRS = ru | |||
5 | CLEANFILES = fluxbox.1 fluxstyle.1 | 5 | CLEANFILES = fluxbox.1 fluxstyle.1 |
6 | MAINTAINERCLEANFILES = Makefile.in | 6 | MAINTAINERCLEANFILES = Makefile.in |
7 | man_MANS = fluxbox.1 fbsetroot.1 fbrun.1 fbsetbg.1 \ | 7 | man_MANS = fluxbox.1 fbsetroot.1 fbrun.1 fbsetbg.1 \ |
8 | startfluxbox.1 fluxstyle.1 fbrun.1 fluxbox-keys.5 | 8 | startfluxbox.1 fluxstyle.1 fbrun.1 fluxbox-keys.5 fluxbox-remote.1 |
9 | EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 startfluxbox.1 fbsetbg.1 \ | 9 | EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 startfluxbox.1 fbsetbg.1 \ |
10 | fluxstyle.1.in CODESTYLE | 10 | fluxstyle.1.in CODESTYLE |
11 | distclean-local: | 11 | distclean-local: |
diff --git a/doc/asciidoc/fluxbox-remote.txt b/doc/asciidoc/fluxbox-remote.txt new file mode 100644 index 0000000..220f794 --- /dev/null +++ b/doc/asciidoc/fluxbox-remote.txt | |||
@@ -0,0 +1,40 @@ | |||
1 | fluxbox-remote(1) | ||
2 | =============== | ||
3 | Mark Tiefenbruck <mark@fluxbox.org> | ||
4 | v1.0.0, 6 August, 2008 | ||
5 | |||
6 | NAME | ||
7 | ---- | ||
8 | fluxbox-remote - command line access to key commands for fluxbox(1) | ||
9 | |||
10 | SYNOPSIS | ||
11 | -------- | ||
12 | *fluxbox-remote* 'command' | ||
13 | |||
14 | DESCRIPTION | ||
15 | ----------- | ||
16 | 'fluxbox-remote(1)' is designed to allow scripts to execute most key commands from 'fluxbox(1)'. 'fluxbox-remote(1)' will only work with 'fluxbox(1)': its communications with 'fluxbox(1)' are not standardized in any way. It is recommended that a standards-based tool such as 'wmctrl(1)' be used whenever possible, in order for scripts to work with other window managers. | ||
17 | |||
18 | CAVEATS | ||
19 | ------- | ||
20 | 'fluxbox-remote(1)' uses the X11 protocol to communicate with 'fluxbox(1)'. | ||
21 | Therefore, it is possible for any user with access to the 'X(7)' server to use | ||
22 | 'fluxbox-remote(1)'. For this reason, several key commands have been disabled. | ||
23 | Users should be aware of the security implications when enabling | ||
24 | 'fluxbox-remote(1)', especially when using a forwarded 'X(7)' connection. | ||
25 | |||
26 | RESOURCES | ||
27 | --------- | ||
28 | session.screen0.allowRemoteActions: <boolean>:: | ||
29 | This resource in ~/.fluxbox/init must be set to `true' in order for | ||
30 | 'fluxbox-remote(1)' to function. Please read the *CAVEATS* first. | ||
31 | |||
32 | ENVIRONMENT | ||
33 | ----------- | ||
34 | In order to communicate with 'fluxbox(1)', the DISPLAY environment variable must | ||
35 | be set properly. Usually, the value should be `:0.0'. | ||
36 | |||
37 | SEE ALSO | ||
38 | -------- | ||
39 | fluxbox(1), fluxbox-keys(5), wmctrl(1) | ||
40 | |||
diff --git a/doc/fluxbox-remote.1 b/doc/fluxbox-remote.1 new file mode 100644 index 0000000..0a7457c --- /dev/null +++ b/doc/fluxbox-remote.1 | |||
@@ -0,0 +1,39 @@ | |||
1 | .\" Title: fluxbox-remote | ||
2 | .\" Author: | ||
3 | .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> | ||
4 | .\" Date: 08/06/2008 | ||
5 | .\" Manual: | ||
6 | .\" Source: | ||
7 | .\" | ||
8 | .TH "FLUXBOX\-REMOTE" "1" "08/06/2008" "" "" | ||
9 | .\" disable hyphenation | ||
10 | .nh | ||
11 | .\" disable justification (adjust text to left margin only) | ||
12 | .ad l | ||
13 | .SH "NAME" | ||
14 | fluxbox-remote - command line access to key commands for fluxbox(1) | ||
15 | .SH "SYNOPSIS" | ||
16 | \fBfluxbox\-remote\fR \fIcommand\fR | ||
17 | .sp | ||
18 | .SH "DESCRIPTION" | ||
19 | \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\. | ||
20 | .sp | ||
21 | .SH "CAVEATS" | ||
22 | \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\. | ||
23 | .sp | ||
24 | .SH "RESOURCES" | ||
25 | .PP | ||
26 | session\.screen0\.allowRemoteActions: <boolean> | ||
27 | .RS 4 | ||
28 | This resource in ~/\.fluxbox/init must be set to `true\' in order for | ||
29 | \fIfluxbox\-remote(1)\fR | ||
30 | to function\. Please read the | ||
31 | \fBCAVEATS\fR | ||
32 | first\. | ||
33 | .RE | ||
34 | .SH "ENVIRONMENT" | ||
35 | In order to communicate with \fIfluxbox(1)\fR, the DISPLAY environment variable must be set properly\. Usually, the value should be `:0\.0\'\. | ||
36 | .sp | ||
37 | .SH "SEE ALSO" | ||
38 | fluxbox(1), fluxbox\-keys(5), wmctrl(1) | ||
39 | .sp | ||