Debian Codegraph @

upstream/debian-unstable/man5/icewm-toolbar.5

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "ICEWM-TOOLBAR 5"
58 .TH ICEWM-TOOLBAR 5 2026-01-18 "icewm\ 4.0.0" "Standards, Environments and Macros"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SS NAME
64 .IX Subsection "NAME"
65 .Vb 1
66 \& icewm\-toolbar \- icewm toolbar configuration file
67 .Ve
68 .SS SYNOPSIS
69 .IX Subsection "SYNOPSIS"
70 .Vb 5
71 \& $ICEWM_PRIVCFG/toolbar
72 \& $XDG_CONFIG_HOME/icewm/toolbar
73 \& $HOME/.icewm/toolbar
74 \& /etc/X11/icewm/toolbar
75 \& /usr/share/icewm/toolbar
76 .Ve
77 .SS DESCRIPTION
78 .IX Subsection "DESCRIPTION"
79 The \fItoolbar\fR file is responsible for configuring quick launch
80 application icons that are placed on the \fBicewm\fR\|(1) panel. It
81 contains names of quick to launch applications with icons for the task
82 bar. Each non-empty non-comment line starts with the keyword \fBprog\fR.
83 After one or more spaces follows a name, which is displayed in a tool
84 tip whenever the mouse cursor hovers over the toolbar icon. This name
85 may be a double quoted string. Then follows the bare name of the icon
86 to use without extensions. This icon will be shown in the toolbar. The
87 last component is a shell command line that will be executed whenever
88 the user presses the icon in the toolbar. For example, the following
89 line in toolbar will create a button with tool tip \f(CW\*(C`Mozilla Firefox\*(C'\fR
90 with the \fIfirefox\fR icon which launches \fBfirefox\fR\|(1) when clicked:
91 .PP
92 .Vb 1
93 \& prog "Mozilla Firefox" firefox /usr/bin/firefox \-\-private\-window
94 .Ve
95 .SS FORMAT
96 .IX Subsection "FORMAT"
97 The format of the file contains one of the following line syntax:
98 .Sp
99 .RS 4
100 \&\fBprog\fR \fB"\fR\fItitle\fR\fB"\fR \fIicon\fR \fIprogram\fR \fIoptions\fR
101 .RE
102 .PP
103 Where,
104 .IP \fBprog\fR 4
105 .IX Item "prog"
106 The literal string \fBprog\fR.
107 .IP "\fB""\fR\fItitle\fR\fB""\fR" 4
108 .IX Item """title"""
109 The title of the toolbar item, which will appear as a tool-tip for the
110 program button, enclosed in double quotes (\f(CW\*(C`"\*(C'\fR).
111 .IP \fIicon\fR 4
112 .IX Item "icon"
113 The icon to display on the toolbar button. May be specified as a single
114 dash (\f(CW\*(C`\-\*(C'\fR) when no icon is provided. When no icon is provided, the
115 \&\fItitle\fR text will be displayed on the button in place of the icon.
116 .IP \fIprogram\fR 4
117 .IX Item "program"
118 The executable program (full path or executable name) to run when the
119 button is pressed.
120 .IP \fIoptions\fR 4
121 .IX Item "options"
122 Options and arguments that are passed to \fIprogram\fR.
123 .PP
124 Lines beginning with a hash (\f(CW\*(C`#\*(C'\fR) are comment lines. Comment lines and
125 blank lines are ignored.
126 .PP
127 Please note that all keywords from \fBicewm\-menu\fR\|(5) are permitted here
128 as well.
129 .SS EXAMPLES
130 .IX Subsection "EXAMPLES"
131 Following is an example that places a number of toolbar buttons on the
132 \&\fBicewm\fR\|(1) panel:
133 .PP
134 .Vb 8
135 \& prog "File Manager" file\-manager.png pcmanfm
136 \& prog "Web Browser" web\-browser.png /usr/lib/firefox/firefox
137 \& prog "Terminal" terminal.png roxterm
138 \& prog "Graphical Editor" text\-editor.png gvim \-f
139 \& prog "Calculator" accessories\-calculator.png calculator
140 \& prog "Run Command" gtk\-execute.png xde\-run
141 \& prog "Network" gtk\-network.png pcmanfm ~/Network
142 \& prog "Logout" system\-log\-out.png xde\-logout
143 .Ve
144 .SS FILES
145 .IX Subsection "FILES"
146 Locations for the \fItoolbar\fR file are as follows:
147 .PP
148 .Vb 5
149 \& $ICEWM_PRIVCFG/toolbar
150 \& $XDG_CONFIG_HOME/icewm/toolbar
151 \& $HOME/.icewm/toolbar
152 \& /etc/X11/icewm/toolbar
153 \& /usr/share/icewm/toolbar
154 .Ve
155 .PP
156 The locations are searched in the order listed; the first file found is
157 read and the remainder ignored.
158 .SS "SEE ALSO"
159 .IX Subsection "SEE ALSO"
160 \&\fBicewm\fR\|(1),
161 \&\fBicewm\-programs\fR\|(5),
162 \&\fBicewm\-menu\fR\|(5),
163 \&\fBicewm\-menu\-fdo\fR\|(1).
164 .SS AUTHOR
165 .IX Subsection "AUTHOR"
166 Brian Bidulock <mailto:[email protected]>.
167 .SS LICENSE
168 .IX Subsection "LICENSE"
169 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
170 See the \fICOPYING\fR file in the distribution.