path: root/upstream/debian-unstable/man5/icewm-toolbar.5

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ICEWM-TOOLBAR 5"
.TH ICEWM-TOOLBAR 5 "2023-12-31" "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 "\s-1NAME\s0"
.IX Subsection "NAME"
.Vb 1
\& icewm\-toolbar \- icewm toolbar configuration file
.Ve
.SS "\s-1SYNOPSIS\s0"
.IX Subsection "SYNOPSIS"
.Vb 5
\& $ICEWM_PRIVCFG/toolbar
\& $XDG_CONFIG_HOME/icewm/toolbar
\& $HOME/.icewm/toolbar
\& /etc/X11/icewm/toolbar
\& /usr/share/icewm/toolbar
.Ve
.SS "\s-1DESCRIPTION\s0"
.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 "\s-1FORMAT\s0"
.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.
.ie n .IP "\fB""\fR\fItitle\fR\fB""\fR" 4
.el .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 "\s-1EXAMPLES\s0"
.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 "\s-1FILES\s0"
.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/X11/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 "\s-1SEE ALSO\s0"
.IX Subsection "SEE ALSO"
\&\fBicewm\fR\|(1),
\&\fBicewm\-programs\fR\|(5),
\&\fBicewm\-menu\fR\|(5),
\&\fBicewm\-menu\-fdo\fR\|(1).
.SS "\s-1AUTHOR\s0"
.IX Subsection "AUTHOR"
Brian Bidulock <mailto:bidulock@openss7.org>.
.SS "\s-1LICENSE\s0"
.IX Subsection "LICENSE"
\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License.
See the \fI\s-1COPYING\s0\fR file in the distribution.