tk-sls.de/xdg-desktop-search
1
0
Fork 0
Code Issues Pull requests Releases Packages Activity

slight manpage formatting corrections

Browse source
This commit is contained in:
Tilman Kranz 2025-05-30 19:37:12 +02:00
parent 0eb7823f56
commit 3c51b624e5
3 changed files with 13 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -14,7 +14,7 @@ $(README): $(PROGRAM)
./$(PROGRAM) --help > $(README) ./$(PROGRAM) --help > $(README)
$(MANPAGE): $(README) $(MANPAGE): $(README)
ronn < $(README) > $(MANPAGE) ronn --date=$$(date +"%Y-%m-%d") --manual="User Commands" --organization=tk-sls.de/git --section="1" < $(README) > $(MANPAGE)
.PHONY: all install install-bin install-doc install-man .PHONY: all install install-bin install-doc install-man

2
README.md
View file

@ -56,7 +56,7 @@ specified by `XDG_DATA_DIRS`. To match, the string "firefox" must be contained
in either the "Exec" or the "Comment" directive. List the matching files, also in either the "Exec" or the "Comment" directive. List the matching files, also
show the "Exec" and "TryExec" directives in each found file. show the "Exec" and "TryExec" directives in each found file.
```shell ```
xdg-desktop-search -s Exec -s Comment -v -d Exec -d TryExec firefox xdg-desktop-search -s Exec -s Comment -v -d Exec -d TryExec firefox
``` ```

27
xdg-desktop-search.1
View file

@ -1,12 +1,10 @@
.\" generated with Ronn-NG/v0.10.1 .\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "XDG\-DESKTOP\-SEARCH" "1" "November 2024" "" .TH "XDG\-DESKTOP\-SEARCH" "1" "May 2025" "tk-sls.de/git" "User Commands"
.SH "NAME" .SH "NAME"
\fBXDG\-DESKTOP\-SEARCH\fR \- Search for \.desktop files \fBXDG\-DESKTOP\-SEARCH\fR \- Search for \.desktop files
.SH "SYNOPSIS" .SH "SYNOPSIS"
.nf \fBxdg\-desktop\-search [ OPTIONS ] SEARCH \|\.\|\.\|\.\fR
xdg\-desktop\-search [ OPTIONS ] SEARCH \|\.\|\.\|\.
.fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
xdg\-desktop\-search locates files with names that end in \fB\.desktop\fR in sub\-directories of name "applications" of a collection of directories refered to as "XDG data directories"\. It the searches the lines of such desktop files for "directives", meaning key\-value\-assignments such as \fBExec=/some/program\fR where the assigned value matches one of the search string given as commandline arguments SEARCH\. xdg\-desktop\-search locates files with names that end in \fB\.desktop\fR in sub\-directories of name "applications" of a collection of directories refered to as "XDG data directories"\. It the searches the lines of such desktop files for "directives", meaning key\-value\-assignments such as \fBExec=/some/program\fR where the assigned value matches one of the search string given as commandline arguments SEARCH\.
.P .P
@ -16,28 +14,25 @@ xdg\-desktop\-search returns successfully if the search rendered one or more res
.P .P
The path of XDG directories searched can be modified by altering the environment variable \fBXDG_DATA_DIRS\fR\. The path of XDG directories searched can be modified by altering the environment variable \fBXDG_DATA_DIRS\fR\.
.SH "ARGUMENTS" .SH "ARGUMENTS"
.IP "\(bu" 4 .IP "\[ci]" 4
\fBSEARCH\fR: Search \.desktop files with search directives containing this string\. The searched directives are "Name" and "Exec" by default but can be overridden using the \fB\-s\fR option (see below)\. \fBSEARCH\fR: Search \.desktop files with search directives containing this string\. The searched directives are "Name" and "Exec" by default but can be overridden using the \fB\-s\fR option (see below)\.
.IP "" 0 .IP "" 0
.SH "OPTIONS" .SH "OPTIONS"
.IP "\(bu" 4 .IP "\[ci]" 4
\fB\-h\fR, \fB\-\-help\fR: Print this message and exit\. \fB\-h\fR, \fB\-\-help\fR: Print this message and exit\.
.IP "\(bu" 4 .IP "\[ci]" 4
\fB\-v\fR, \fB\-\-verbose\fR: Print directives in found \.desktop files\. \fB\-v\fR, \fB\-\-verbose\fR: Print directives in found \.desktop files\.
.IP "\(bu" 4 .IP "\[ci]" 4
\fB\-d STRING\fR, \fB\-\-show\-directive STRING\fR: Instead of printing all directives when searching in verbose mode, print only the directive given by \fBSTRING\fR (e\.g\. "Name")\. Option can be repeated to print multiple directives\. \fB\-d STRING\fR, \fB\-\-show\-directive STRING\fR: Instead of printing all directives when searching in verbose mode, print only the directive given by \fBSTRING\fR (e\.g\. "Name")\. Option can be repeated to print multiple directives\.
.IP "\(bu" 4 .IP "\[ci]" 4
\fB\-s STRING\fR, \fB\-\-search\-directive STRING\fR: Instead of searching directives "Name" and "Exec" for strings containing \fBSEARCH\fR, search the given directive instead (e\.g\. "Comment")\. Option can be repeated to search in multiple directives\. \fB\-s STRING\fR, \fB\-\-search\-directive STRING\fR: Instead of searching directives "Name" and "Exec" for strings containing \fBSEARCH\fR, search the given directive instead (e\.g\. "Comment")\. Option can be repeated to search in multiple directives\.
.IP "" 0 .IP "" 0
.SH "RETURN VALUES" .SH "RETURN VALUES"
The command returns 0 if \.desktop files were found that match the specified criteria, 1 on usage error and 2 if no matching \.desktop files were found\. The command returns 0 if \.desktop files were found that match the specified criteria, 1 on usage error and 2 if no matching \.desktop files were found\.
.SH "EXAMPLE" .SH "EXAMPLE"
Search for the string "firefox" in all \.desktop files found in the path specified by \fBXDG_DATA_DIRS\fR\. To match, the string "firefox" must be contained in either the "Exec" or the "Comment" directive\. List the matching files, also show the "Exec" and "TryExec" directives in each found file\. Search for the string "firefox" in all \.desktop files found in the path specified by \fBXDG_DATA_DIRS\fR\. To match, the string "firefox" must be contained in either the "Exec" or the "Comment" directive\. List the matching files, also show the "Exec" and "TryExec" directives in each found file\.
.IP "" 4 .P
.nf \fBxdg\-desktop\-search \-s Exec \-s Comment \-v \-d Exec \-d TryExec firefox\fR
xdg\-desktop\-search \-s Exec \-s Comment \-v \-d Exec \-d TryExec firefox
.fi
.IP "" 0
.SH "AUTHOR AND COPYRIGHT" .SH "AUTHOR AND COPYRIGHT"
Copyright \(co 2024 Tilman Kranz \fIt\.kranz@tk\-sls\.de\fR Copyright \(co 2024 Tilman Kranz \fIt\.kranz@tk\-sls\.de\fR
.SH "LICENSE" .SH "LICENSE"