summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-40/man1/icewm-menu-fdo.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/fedora-40/man1/icewm-menu-fdo.1')
-rw-r--r--upstream/fedora-40/man1/icewm-menu-fdo.1190
1 files changed, 190 insertions, 0 deletions
diff --git a/upstream/fedora-40/man1/icewm-menu-fdo.1 b/upstream/fedora-40/man1/icewm-menu-fdo.1
new file mode 100644
index 00000000..aad397d6
--- /dev/null
+++ b/upstream/fedora-40/man1/icewm-menu-fdo.1
@@ -0,0 +1,190 @@
+.\" -*- 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-MENU-FDO 1"
+.TH ICEWM-MENU-FDO 1 2024-01-24 "icewm\ 3.4.5" "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 NAME
+.IX Subsection "NAME"
+.Vb 1
+\& icewm\-menu\-fdo \- menu generator for .desktop files
+.Ve
+.SS SYNOPSIS
+.IX Subsection "SYNOPSIS"
+\&\fBicewm-menu-fdo\fR [\fIOPTIONS\fR] [\fIFILENAME\fR]
+.SS DESCRIPTION
+.IX Subsection "DESCRIPTION"
+\&\fBicewm-menu-fdo\fR generates a menu for the \fBIceWM\fR window manager
+from XDG 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 ARGUMENTS
+.IX Subsection "ARGUMENTS"
+.IP [\fIFILENAME\fR] 4
+.IX Item "[FILENAME]"
+The optional \fIFILENAME\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 OPTIONS
+.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 \fIFILE\fR.
+.IP "\fB\-t\fR, \fB\-\-terminal=NAME\fR" 4
+.IX Item "-t, --terminal=NAME"
+Use \fINAME\fR to start a terminal emulator that supports the '\-e' option.
+.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 that 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 USAGE
+.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 EXAMPLES
+.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 ENVIRONMENT
+.IX Subsection "ENVIRONMENT"
+\&\fBXDG_DATA_HOME\fR or \fBXDG_DATA_DIRS\fR are considered as suggested by XDG
+Base Directory Specification.
+.PP
+\&\fBTERMINAL\fR may define a terminal emulator that supports the '\-e' option.
+.SS "CONFORMING TO"
+.IX Subsection "CONFORMING TO"
+\&\fBicewm-menu-fdo\fR complies roughly to the XDG \fI.desktop\fR file and menu
+specification, see "Desktop Entry Specification", Version 1.2alpha,
+2015\-03\-06 and "Desktop Menu Specification", Version 1.1\-draft, 31
+March 2011.
+.SS CAVEATS
+.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 "SEE ALSO"
+.IX Subsection "SEE ALSO"
+"Desktop Entry Specification",
+"Desktop Menu Specification",
+\&\fBicewm\fR\|(1),
+\&\fBicewm\-menu\fR\|(5),
+\&\fBicewm\-preferences\fR\|(5),
+\&\fBicewm\-programs\fR\|(5).
+.SS BUGS
+.IX Subsection "BUGS"
+Please report bugs at <https://github.com/bbidulock/icewm/issues>.
+.SS AUTHOR
+.IX Subsection "AUTHOR"
+Eduard Bloch <mailto:edi@gmx.de>.
+.PP
+See \fB\-\-copying\fR for full copyright notice and copying permissions.
+.SS LICENSE
+.IX Subsection "LICENSE"
+\&\fBIceWM\fR is licensed under the GNU Library General Public License.
+See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag
+to display copying permissions.