Skip to content

Commit

Permalink
add basic man page - fixes labwc#17
Browse files Browse the repository at this point in the history
  • Loading branch information
01micko committed May 23, 2024
1 parent 7b62ce9 commit f3fd35a
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 0 deletions.
41 changes: 41 additions & 0 deletions data/labwc-menu-generator.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.TH labwc-menu-generator: "1" "2024-05-23"
.SH NAME
labwc-menu-generator
.SH SYNOPSIS
.B labwc-menu-generator
[\fI\,options\/\fR...]
.SH DESCRIPTION
.TP
This is independent of Desktop Environments and associated menu-packages.
.TP
This is achieved by categorising system .desktop files against a built-in directory-schema rather than parsing .menu and .directory files.
.SH USAGE
.TP
\fB\-b\fR, \fB\-\-bare\fR
Show no header or footer
.TP
\fB\-d\fR, \fB\-\-desktop\fR
Add .desktop filename as a comment in the XML output
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help message and quit
.TP
\fB\-i\fR, \fB\-\-ignore\fR <file>
Specify file listing .desktop files to ignore
.TP
\fB\-n\fR, \fB\-\-no\-duplicates\fR
Limit desktop entries to one directory only
.TP
\fB\-p\fR, \fB\-\-pipemenu\fR
Output in pipemenu format
.SH AUTHORS
.TP
The Labwc Team \- https://github.com/labwc/labwc-menu-generator
.SH REPORT BUGS
.TP
Please report any bugs at:
.TP
https://github.com/labwc/labwc-menu-generator/issues/
.SH SEE ALSO
.TP
labwc(1), labwc-menu(5), labwc-actions(5)
4 changes: 4 additions & 0 deletions data/meson.build
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
install_data(
'labwc-menu-generator.1',
install_dir : join_paths(get_option('datadir'), 'man', 'man1'),
)
2 changes: 2 additions & 0 deletions meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ executable(
dependencies: [glib],
install: true,
)

subdir('data')

0 comments on commit f3fd35a

Please sign in to comment.