summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man1/icewm-menu-fdo.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-bookworm/man1/icewm-menu-fdo.1')
-rw-r--r--upstream/debian-bookworm/man1/icewm-menu-fdo.1263
1 files changed, 263 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man1/icewm-menu-fdo.1 b/upstream/debian-bookworm/man1/icewm-menu-fdo.1
new file mode 100644
index 00000000..d5d6607a
--- /dev/null
+++ b/upstream/debian-bookworm/man1/icewm-menu-fdo.1
@@ -0,0 +1,263 @@
+.\" 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-MENU-FDO 1"
+.TH ICEWM-MENU-FDO 1 "2023-02-05" "icewm\ 3.3.1" "User Commands"
+.\" 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\-menu\-fdo \- menu generator for .desktop files
+.Ve
+.SS "\s-1SYNOPSIS\s0"
+.IX Subsection "SYNOPSIS"
+\&\fBicewm-menu-fdo\fR [\fI\s-1OPTIONS\s0\fR] [\fI\s-1FILENAME\s0\fR]
+.SS "\s-1DESCRIPTION\s0"
+.IX Subsection "DESCRIPTION"
+\&\fBicewm-menu-fdo\fR generates a menu for the \fBIceWM\fR window manager
+from \s-1XDG\s0 menu descriptors (aka FreeDesktop.Org \fI.desktop\fR files).
+By including this in the \fBicewm\-menu\fR\|(1), the system applications
+become available in the icewm start menu.
+.SS "\s-1ARGUMENTS\s0"
+.IX Subsection "ARGUMENTS"
+.IP "[\fI\s-1FILENAME\s0\fR]" 4
+.IX Item "[FILENAME]"
+The optional \fI\s-1FILENAME\s0\fR argument is the location of a \fI.desktop\fR file.
+When given, \fBicewm-menu-fdo\fR launches the application using the \f(CW\*(C`Exec\*(C'\fR
+line from the desktop file.
+.SS "\s-1OPTIONS\s0"
+.IX Subsection "OPTIONS"
+.IP "\fB\-g\fR, \fB\-\-generic\fR" 4
+.IX Item "-g, --generic"
+Include the generic name in parentheses in the title of \fBprog\fR entries.
+.IP "\fB\-\-seps\fR" 4
+.IX Item "--seps"
+Print a leading and a trailing separator.
+.IP "\fB\-\-sep\-before\fR" 4
+.IX Item "--sep-before"
+Print a leading separator.
+.IP "\fB\-\-sep\-after\fR" 4
+.IX Item "--sep-after"
+Print a trailing separator.
+.IP "\fB\-\-no\-sep\-others\fR" 4
+.IX Item "--no-sep-others"
+Don't print the \f(CW\*(C`Other\*(C'\fR category last.
+.IP "\fB\-\-no\-sub\-cats\fR" 4
+.IX Item "--no-sub-cats"
+Don't nest subcategories in submenus.
+.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4
+.IX Item "-o, --output=FILE"
+Write the output to \fI\s-1FILE\s0\fR.
+.IP "\fB\-\-flat\fR" 4
+.IX Item "--flat"
+Display apps from all categories in one level with the title containing
+the category information as prefix.
+.IP "\fB\-F sep\fR, \fB\-\-flat\-sep=sep\fR" 4
+.IX Item "-F sep, --flat-sep=sep"
+When used with \f(CW\*(C`\-\-flat\*(C'\fR, the specified character sequence is used as
+separator between the section titles.
+.IP "\fB\-m filter\fR, \fB\-\-match=filter\fR" 4
+.IX Item "-m filter, --match=filter"
+Specifies a filter to show only apps which contain this as substring
+within their title.
+.IP "\fB\-M filter\fR, \fB\-\-imatch=filter\fR" 4
+.IX Item "-M filter, --imatch=filter"
+Like \f(CW\*(C`\-\-match\*(C'\fR but applied with any letter case.
+.IP "\fB\-\-match\-sec\fR" 4
+.IX Item "--match-sec"
+Apply the filter from \f(CW\*(C`\-\-match\*(C'\fR or \f(CW\*(C`\-\-imatch\*(C'\fR to both, apps and
+section titles.
+.IP "\fB\-\-match\-osec\fR" 4
+.IX Item "--match-osec"
+Apply the filter from \f(CW\*(C`\-\-match\*(C'\fR or \f(CW\*(C`\-\-imatch\*(C'\fR to only to section titles.
+.IP "\fB\-h\fR, \fB\-\-help\fR" 4
+.IX Item "-h, --help"
+Print a brief usage statement to \fIstdout\fR and exit.
+.IP "\fB\-V\fR, \fB\-\-version\fR" 4
+.IX Item "-V, --version"
+Print the program version to \fIstdout\fR and exit.
+.IP "\fB\-C\fR, \fB\-\-copying\fR" 4
+.IX Item "-C, --copying"
+Print copying permissions to \fIstdout\fR for the program and exit.
+.SS "\s-1USAGE\s0"
+.IX Subsection "USAGE"
+This utility is not normally used directly. It is used as the
+executable in a \fBmenuprog\fR entry in a \fBicewm\-menu\fR\|(5).
+.SS "\s-1EXAMPLES\s0"
+.IX Subsection "EXAMPLES"
+The following line in a \fBicewm\-menu\fR\|(5) file will dynamically generate
+a comprehensive set of menus for easy access to \fI.desktop\fR files.
+.PP
+.Vb 1
+\& menuprog "Desktop Apps" folder icewm\-menu\-fdo
+.Ve
+.SS "\s-1ENVIRONMENT\s0"
+.IX Subsection "ENVIRONMENT"
+\&\fB\s-1XDG_DATA_HOME\s0\fR or \fB\s-1XDG_DATA_DIRS\s0\fR are considered as suggested by \s-1XDG\s0
+Base Directory Specification.
+.SS "\s-1CONFORMING TO\s0"
+.IX Subsection "CONFORMING TO"
+\&\fBicewm-menu-fdo\fR complies roughly to the \s-1XDG\s0 \fI.desktop\fR file and menu
+specification, see \*(L"Desktop Entry Specification\*(R", Version 1.2alpha,
+2015\-03\-06 and \*(L"Desktop Menu Specification\*(R", Version 1.1\-draft, 31
+March 2011.
+.SS "\s-1CAVEATS\s0"
+.IX Subsection "CAVEATS"
+The \fBicewm-menu-fdo\fR program is only built when the \fBicewm\fR\|(1) package
+is configured with the \fB\-\-enable\-menus\-fdo\fR option, which requires the
+\&\fBglib2\-dev\fR package dependency.
+.SS "\s-1SEE ALSO\s0"
+.IX Subsection "SEE ALSO"
+\&\*(L"Desktop Entry Specification\*(R",
+\&\*(L"Desktop Menu Specification\*(R",
+\&\fBicewm\fR\|(1),
+\&\fBicewm\-menu\fR\|(5),
+\&\fBicewm\-preferences\fR\|(5),
+\&\fBicewm\-programs\fR\|(5).
+.SS "\s-1BUGS\s0"
+.IX Subsection "BUGS"
+Please report bugs at <https://github.com/bbidulock/icewm/issues>.
+.SS "\s-1AUTHOR\s0"
+.IX Subsection "AUTHOR"
+Eduard Bloch <mailto:edi@gmx.de>.
+.PP
+See \fB\-\-copying\fR for full copyright notice and copying permissions.
+.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 or use the \fB\-\-copying\fR flag
+to display copying permissions.