Debian Codegraph @

upstream/mageia-cauldron/man5/icewm-toolbar.5

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "ICEWM-TOOLBAR 5"
61 .TH ICEWM-TOOLBAR 5 2026-01-01 "icewm 4.0.0" "Standards, Environments and Macros"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SS NAME
67 .IX Subsection "NAME"
68 .Vb 1
69 \& icewm\-toolbar \- icewm toolbar configuration file
70 .Ve
71 .SS SYNOPSIS
72 .IX Subsection "SYNOPSIS"
73 .Vb 5
74 \& $ICEWM_PRIVCFG/toolbar
75 \& $XDG_CONFIG_HOME/icewm/toolbar
76 \& $HOME/.icewm/toolbar
77 \& /etc/icewm/toolbar
78 \& /usr/share/icewm/toolbar
79 .Ve
80 .SS DESCRIPTION
81 .IX Subsection "DESCRIPTION"
82 The \fItoolbar\fR file is responsible for configuring quick launch
83 application icons that are placed on the \fBicewm\fR\|(1) panel. It
84 contains names of quick to launch applications with icons for the task
85 bar. Each non\-empty non\-comment line starts with the keyword \fBprog\fR.
86 After one or more spaces follows a name, which is displayed in a tool
87 tip whenever the mouse cursor hovers over the toolbar icon. This name
88 may be a double quoted string. Then follows the bare name of the icon
89 to use without extensions. This icon will be shown in the toolbar. The
90 last component is a shell command line that will be executed whenever
91 the user presses the icon in the toolbar. For example, the following
92 line in toolbar will create a button with tool tip \f(CW\*(C`Mozilla Firefox\*(C'\fR
93 with the \fIfirefox\fR icon which launches \fBfirefox\fR\|(1) when clicked:
94 .PP
95 .Vb 1
96 \& prog "Mozilla Firefox" firefox /usr/bin/firefox \-\-private\-window
97 .Ve
98 .SS FORMAT
99 .IX Subsection "FORMAT"
100 The format of the file contains one of the following line syntax:
101 .Sp
102 .RS 4
103 \&\fBprog\fR \fB"\fR\fItitle\fR\fB"\fR \fIicon\fR \fIprogram\fR \fIoptions\fR
104 .RE
105 .PP
106 Where,
107 .IP \fBprog\fR 4
108 .IX Item "prog"
109 The literal string \fBprog\fR.
110 .IP "\fB""\fR\fItitle\fR\fB""\fR" 4
111 .IX Item """title"""
112 The title of the toolbar item, which will appear as a tool\-tip for the
113 program button, enclosed in double quotes (\f(CW\*(C`"\*(C'\fR).
114 .IP \fIicon\fR 4
115 .IX Item "icon"
116 The icon to display on the toolbar button. May be specified as a single
117 dash (\f(CW\*(C`\-\*(C'\fR) when no icon is provided. When no icon is provided, the
118 \&\fItitle\fR text will be displayed on the button in place of the icon.
119 .IP \fIprogram\fR 4
120 .IX Item "program"
121 The executable program (full path or executable name) to run when the
122 button is pressed.
123 .IP \fIoptions\fR 4
124 .IX Item "options"
125 Options and arguments that are passed to \fIprogram\fR.
126 .PP
127 Lines beginning with a hash (\f(CW\*(C`#\*(C'\fR) are comment lines. Comment lines and
128 blank lines are ignored.
129 .PP
130 Please note that all keywords from \fBicewm\-menu\fR\|(5) are permitted here
131 as well.
132 .SS EXAMPLES
133 .IX Subsection "EXAMPLES"
134 Following is an example that places a number of toolbar buttons on the
135 \&\fBicewm\fR\|(1) panel:
136 .PP
137 .Vb 8
138 \& prog "File Manager" file\-manager.png pcmanfm
139 \& prog "Web Browser" web\-browser.png /usr/lib/firefox/firefox
140 \& prog "Terminal" terminal.png roxterm
141 \& prog "Graphical Editor" text\-editor.png gvim \-f
142 \& prog "Calculator" accessories\-calculator.png calculator
143 \& prog "Run Command" gtk\-execute.png xde\-run
144 \& prog "Network" gtk\-network.png pcmanfm ~/Network
145 \& prog "Logout" system\-log\-out.png xde\-logout
146 .Ve
147 .SS FILES
148 .IX Subsection "FILES"
149 Locations for the \fItoolbar\fR file are as follows:
150 .PP
151 .Vb 5
152 \& $ICEWM_PRIVCFG/toolbar
153 \& $XDG_CONFIG_HOME/icewm/toolbar
154 \& $HOME/.icewm/toolbar
155 \& /etc/icewm/toolbar
156 \& /usr/share/icewm/toolbar
157 .Ve
158 .PP
159 The locations are searched in the order listed; the first file found is
160 read and the remainder ignored.
161 .SS "SEE ALSO"
162 .IX Subsection "SEE ALSO"
163 \&\fBicewm\fR\|(1),
164 \&\fBicewm\-programs\fR\|(5),
165 \&\fBicewm\-menu\fR\|(5),
166 \&\fBicewm\-menu\-fdo\fR\|(1).
167 .SS AUTHOR
168 .IX Subsection "AUTHOR"
169 Brian Bidulock <mailto:[email protected]>.
170 .SS LICENSE
171 .IX Subsection "LICENSE"
172 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
173 See the \fICOPYING\fR file in the distribution.