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