created new fluxbox-remote man page

This commit is contained in:
Mark Tiefenbruck 2008-08-06 03:45:23 -07:00
parent c52a84a170
commit ed2a4580d1
4 changed files with 82 additions and 1 deletions

View file

@ -1,6 +1,8 @@
(Format: Year/Month/Day)
Changes for 1.1
*08/08/06:
* Created manual for fluxbox-remote (Mark)
doc/asciidoc/fluxbox-remote.txt doc/fluxbox-remote.1
* Automatically restore the previous background on startup (Mark)
RootTheme.cc/hh util/fbsetbg startfluxbox.in
*08/08/05:

View file

@ -5,7 +5,7 @@ SUBDIRS = ru
CLEANFILES = fluxbox.1 fluxstyle.1
MAINTAINERCLEANFILES = Makefile.in
man_MANS = fluxbox.1 fbsetroot.1 fbrun.1 fbsetbg.1 \
startfluxbox.1 fluxstyle.1 fbrun.1 fluxbox-keys.5
startfluxbox.1 fluxstyle.1 fbrun.1 fluxbox-keys.5 fluxbox-remote.1
EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 startfluxbox.1 fbsetbg.1 \
fluxstyle.1.in CODESTYLE
distclean-local:

View file

@ -0,0 +1,40 @@
fluxbox-remote(1)
===============
Mark Tiefenbruck <mark@fluxbox.org>
v1.0.0, 6 August, 2008
NAME
----
fluxbox-remote - command line access to key commands for fluxbox(1)
SYNOPSIS
--------
*fluxbox-remote* 'command'
DESCRIPTION
-----------
'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.
CAVEATS
-------
'fluxbox-remote(1)' uses the X11 protocol to communicate with 'fluxbox(1)'.
Therefore, it is possible for any user with access to the 'X(7)' server to use
'fluxbox-remote(1)'. For this reason, several key commands have been disabled.
Users should be aware of the security implications when enabling
'fluxbox-remote(1)', especially when using a forwarded 'X(7)' connection.
RESOURCES
---------
session.screen0.allowRemoteActions: <boolean>::
This resource in ~/.fluxbox/init must be set to `true' in order for
'fluxbox-remote(1)' to function. Please read the *CAVEATS* first.
ENVIRONMENT
-----------
In order to communicate with 'fluxbox(1)', the DISPLAY environment variable must
be set properly. Usually, the value should be `:0.0'.
SEE ALSO
--------
fluxbox(1), fluxbox-keys(5), wmctrl(1)

39
doc/fluxbox-remote.1 Normal file
View file

@ -0,0 +1,39 @@
.\" Title: fluxbox-remote
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: 08/06/2008
.\" Manual:
.\" Source:
.\"
.TH "FLUXBOX\-REMOTE" "1" "08/06/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
fluxbox-remote - command line access to key commands for fluxbox(1)
.SH "SYNOPSIS"
\fBfluxbox\-remote\fR \fIcommand\fR
.sp
.SH "DESCRIPTION"
\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\.
.sp
.SH "CAVEATS"
\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\.
.sp
.SH "RESOURCES"
.PP
session\.screen0\.allowRemoteActions: <boolean>
.RS 4
This resource in ~/\.fluxbox/init must be set to `true\' in order for
\fIfluxbox\-remote(1)\fR
to function\. Please read the
\fBCAVEATS\fR
first\.
.RE
.SH "ENVIRONMENT"
In order to communicate with \fIfluxbox(1)\fR, the DISPLAY environment variable must be set properly\. Usually, the value should be `:0\.0\'\.
.sp
.SH "SEE ALSO"
fluxbox(1), fluxbox\-keys(5), wmctrl(1)
.sp