aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Tagliamonte <paultag@ubuntu.com>2011-04-15 18:48:05 (GMT)
committerPaul Tagliamonte <tag@loki.(none)>2011-09-24 15:48:47 (GMT)
commitcc5c30c9cbdce2693d284c57ae4671017bf0660c (patch)
treece85451dd72abc0dfc8475c20c86e496805110f2 /doc
parent0e1ee49603a565427fa833a4136c586a0e816c47 (diff)
downloadfluxbox_paul-cc5c30c9cbdce2693d284c57ae4671017bf0660c.zip
fluxbox_paul-cc5c30c9cbdce2693d284c57ae4671017bf0660c.tar.bz2
Integrating fbautostart into the Fluxbox tree.
This change merges fbautostart into fluxbox. fbautostart has been re-licensed under MIT to allow for this. I've added the util/fbautostart directory, and tweeked the build chain to include fbautostart. I've also added in a few docs. Those are the only changes outside the util/fbautostart folder. It's been noted in the ChangeLog, but fbautostart changes (since it might be a bit more "high-volume") should be maintained in util/fbautostart/ChangeLog. The XDG spec can be found at: - http://standards.freedesktop.org/autostart-spec/autostart-spec-latest.html
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am17
-rw-r--r--doc/asciidoc/fbautostart.txt85
-rw-r--r--doc/fbautostart.1110
-rw-r--r--doc/fbautostart.1.in110
4 files changed, 315 insertions, 7 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 008e318..07c1f93 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,15 +1,18 @@
1# doc/Makefile.am for Fluxbox 0.9 - an X11 Window manager 1# doc/Makefile.am for Fluxbox 0.9 - an X11 Window manager
2# Makefile.am for fluxbox/doc 2# Makefile.am for fluxbox/doc
3 3
4CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 startfluxbox.1 fluxbox-apps.5 \ 4CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 startfluxbox.1 fluxbox-remote.1 \
5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 5 fbautostart.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-style.5
6
6MAINTAINERCLEANFILES = Makefile.in 7MAINTAINERCLEANFILES = Makefile.in
7man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \ 8
8 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \ 9man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 startfluxbox.1 fluxbox-remote.1 \
9 startfluxbox.1 10 fbautostart.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-style.5
11
10EXTRA_DIST=startfluxbox.1.in CODESTYLE \ 12EXTRA_DIST=startfluxbox.1.in CODESTYLE \
11 fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-apps.5.in \ 13 fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-remote.1.in fbautostart.1.in \
12 fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in 14 fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-apps.5.in fluxbox-style.5.in
15
13distclean-local: 16distclean-local:
14 rm -f *\~ 17 rm -f *\~
15 18
diff --git a/doc/asciidoc/fbautostart.txt b/doc/asciidoc/fbautostart.txt
new file mode 100644
index 0000000..0ad7e05
--- /dev/null
+++ b/doc/asciidoc/fbautostart.txt
@@ -0,0 +1,85 @@
1fbautostart(1)
2==============
3Paul Tagliamonte <paultag@ubuntu.com>
4v2.7.0, 14 October 2010
5:man source: fbautostart.txt
6:man version: {revision}
7:man manual: fbautostart Manual
8
9NAME
10----
11fbautostart - Autostart all XDG applications
12
13SYNOPSIS
14--------
15*fbautostart* ['options']
16
17DESCRIPTION
18-----------
19*fbautostart(1)* is an XDG complaint startup tool. This will
20go through the directories set up by the spec, and start all
21applications that match it's current identifier. You may change
22that identifier with the *--window-manager* flag.
23
24This tool has almost no library dependencies and was written to be smart
25about that sort of stuff. There is a greater then average chance
26that you will find a bug, since it is a from-scratch implementation of the
27.desktop spec. Pleas report bugs. Please.
28
29FILES
30-----
31*~/.config/autostart*::
32 This folder contains the default user XDG dot-desktop files that
33 will be run ( unless it's overridden by an ENV variable )
34
35*/etc/xdg*::
36 This folder contains the default system XDG dot-desktop files that
37 will be run ( unless it's overridden by an ENV variable )
38
39
40OPTIONS
41-------
42*--noexec*::
43 Do not execute any of the files,
44 rather, display what would have been run
45
46*--window-manager* ['WMNAME']::
47 Override the compile-time default window
48 manager, and work on behalf of this instead.
49 This is helpful if you'd like to use this tool in
50 place of another DE's normal XDG Autostarting
51 application
52
53*--license*::
54 Show license information
55
56*--version*::
57 Show basic version information
58
59*--help*::
60 Show basic usage and flags
61
62ENVIRONMENT VARIABLES
63---------------------
64*XDG_CONFIG_HOME*::
65 The XDG root directory for the user's startup
66 files, which may override the global startup files.
67
68*XDG_CONFIG_DIRS*::
69 The root XDG directory, where global XDG files are
70 maintained.
71
72
73EXAMPLE
74-------
75....
76fbautostart
77....
78
79AUTHORS
80-------
81Paul Tagliamonte <paultag@ubuntu.com> for fbautostart 2.7
82
83SEE ALSO
84--------
85fluxbox(1)
diff --git a/doc/fbautostart.1 b/doc/fbautostart.1
new file mode 100644
index 0000000..0d5d41d
--- /dev/null
+++ b/doc/fbautostart.1
@@ -0,0 +1,110 @@
1'\" t
2.\" Title: fbautostart
3.\" Author: [see the "AUTHORS" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 01/31/2011
6.\" Manual: fbautostart Manual
7.\" Source: fbautostart.txt
8.\" Language: English
9.\"
10.TH "FBAUTOSTART" "1" "01/31/2011" "fbautostart\&.txt" "fbautostart Manual"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31fbautostart \- Autostart all XDG applications
32.SH "SYNOPSIS"
33.sp
34\fBfbautostart\fR [\fIoptions\fR]
35.SH "DESCRIPTION"
36.sp
37\fBfbautostart(1)\fR is an XDG complaint startup tool\&. This will go through the directories set up by the spec, and start all applications that match it\(cqs current identifier\&. You may change that identifier with the \fB\-\-window\-manager\fR flag\&.
38.sp
39This tool has almost no library dependencies and was written to be smart about that sort of stuff\&. There is a greater then average chance that you will find a bug, since it is a from\-scratch implementation of the \&.desktop spec\&. Pleas report bugs\&. Please\&.
40.SH "FILES"
41.PP
42\fB~/\&.config/autostart\fR
43.RS 4
44This folder contains the default user XDG dot\-desktop files that will be run ( unless it\(cqs overridden by an ENV variable )
45.RE
46.PP
47\fB/etc/xdg\fR
48.RS 4
49This folder contains the default system XDG dot\-desktop files that will be run ( unless it\(cqs overridden by an ENV variable )
50.RE
51.SH "OPTIONS"
52.PP
53\fB\-\-noexec\fR
54.RS 4
55Do not execute any of the files, rather, display what would have been run
56.RE
57.PP
58\fB\-\-window\-manager\fR [\fIWMNAME\fR]
59.RS 4
60Override the compile\-time default window manager, and work on behalf of this instead\&. This is helpful if you\(cqd like to use this tool in place of another DE\(cqs normal XDG Autostarting application
61.RE
62.PP
63\fB\-\-license\fR
64.RS 4
65Show license information
66.RE
67.PP
68\fB\-\-version\fR
69.RS 4
70Show basic version information
71.RE
72.PP
73\fB\-\-help\fR
74.RS 4
75Show basic usage and flags
76.RE
77.SH "ENVIRONMENT VARIABLES"
78.PP
79\fBXDG_CONFIG_HOME\fR
80.RS 4
81The XDG root directory for the user\(cqs startup files, which may override the global startup files\&.
82.RE
83.PP
84\fBXDG_CONFIG_DIRS\fR
85.RS 4
86The root XDG directory, where global XDG files are maintained\&.
87.RE
88.SH "EXAMPLE"
89.sp
90.if n \{\
91.RS 4
92.\}
93.nf
94fbautostart
95.fi
96.if n \{\
97.RE
98.\}
99.SH "AUTHORS"
100.sp
101Paul Tagliamonte <\m[blue]\fBpaultag@ubuntu\&.com\fR\m[]\&\s-2\u[1]\d\s+2> for fbautostart 2\&.7
102.SH "SEE ALSO"
103.sp
104fluxbox(1)
105.SH "NOTES"
106.IP " 1." 4
107paultag@ubuntu.com
108.RS 4
109\%mailto:paultag@ubuntu.com
110.RE
diff --git a/doc/fbautostart.1.in b/doc/fbautostart.1.in
new file mode 100644
index 0000000..0d5d41d
--- /dev/null
+++ b/doc/fbautostart.1.in
@@ -0,0 +1,110 @@
1'\" t
2.\" Title: fbautostart
3.\" Author: [see the "AUTHORS" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 01/31/2011
6.\" Manual: fbautostart Manual
7.\" Source: fbautostart.txt
8.\" Language: English
9.\"
10.TH "FBAUTOSTART" "1" "01/31/2011" "fbautostart\&.txt" "fbautostart Manual"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31fbautostart \- Autostart all XDG applications
32.SH "SYNOPSIS"
33.sp
34\fBfbautostart\fR [\fIoptions\fR]
35.SH "DESCRIPTION"
36.sp
37\fBfbautostart(1)\fR is an XDG complaint startup tool\&. This will go through the directories set up by the spec, and start all applications that match it\(cqs current identifier\&. You may change that identifier with the \fB\-\-window\-manager\fR flag\&.
38.sp
39This tool has almost no library dependencies and was written to be smart about that sort of stuff\&. There is a greater then average chance that you will find a bug, since it is a from\-scratch implementation of the \&.desktop spec\&. Pleas report bugs\&. Please\&.
40.SH "FILES"
41.PP
42\fB~/\&.config/autostart\fR
43.RS 4
44This folder contains the default user XDG dot\-desktop files that will be run ( unless it\(cqs overridden by an ENV variable )
45.RE
46.PP
47\fB/etc/xdg\fR
48.RS 4
49This folder contains the default system XDG dot\-desktop files that will be run ( unless it\(cqs overridden by an ENV variable )
50.RE
51.SH "OPTIONS"
52.PP
53\fB\-\-noexec\fR
54.RS 4
55Do not execute any of the files, rather, display what would have been run
56.RE
57.PP
58\fB\-\-window\-manager\fR [\fIWMNAME\fR]
59.RS 4
60Override the compile\-time default window manager, and work on behalf of this instead\&. This is helpful if you\(cqd like to use this tool in place of another DE\(cqs normal XDG Autostarting application
61.RE
62.PP
63\fB\-\-license\fR
64.RS 4
65Show license information
66.RE
67.PP
68\fB\-\-version\fR
69.RS 4
70Show basic version information
71.RE
72.PP
73\fB\-\-help\fR
74.RS 4
75Show basic usage and flags
76.RE
77.SH "ENVIRONMENT VARIABLES"
78.PP
79\fBXDG_CONFIG_HOME\fR
80.RS 4
81The XDG root directory for the user\(cqs startup files, which may override the global startup files\&.
82.RE
83.PP
84\fBXDG_CONFIG_DIRS\fR
85.RS 4
86The root XDG directory, where global XDG files are maintained\&.
87.RE
88.SH "EXAMPLE"
89.sp
90.if n \{\
91.RS 4
92.\}
93.nf
94fbautostart
95.fi
96.if n \{\
97.RE
98.\}
99.SH "AUTHORS"
100.sp
101Paul Tagliamonte <\m[blue]\fBpaultag@ubuntu\&.com\fR\m[]\&\s-2\u[1]\d\s+2> for fbautostart 2\&.7
102.SH "SEE ALSO"
103.sp
104fluxbox(1)
105.SH "NOTES"
106.IP " 1." 4
107paultag@ubuntu.com
108.RS 4
109\%mailto:paultag@ubuntu.com
110.RE