-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathgendesk.1
125 lines (125 loc) · 3.19 KB
/
gendesk.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
.\" -*-Nroff-*-
.\"
.TH "gendesk" 1 "20 May 2024" "" ""
.SH NAME
gendesk \- generate .desktop files based on command-line arguments (or a PKGBUILD file)
.SH SYNOPSIS
.B gendesk
[flags or PKGBUILD file]
.SH DESCRIPTION
Supported PKGBUILD variables that will be included in the generated file:
.sp
.B _name
.sp
.B _genericname
.sp
.B _comment
.sp
.B _mimetype
.sp
.B _exec
.sp
.B _categories
.sp
Gendesk will try to find the correct icon from the Open Icon Library or else fall back on the default icon.
.sp
The correct application category will be guessed if not provided.
.sp.
Supported environment variables:
.sp
.B pkgname
.sp
.B pkgdesc
.sp
.SH "EXAMPLES"
.B gendesk
Exits with error code 1 if ../PKGBUILD is not found and pkgname is not given and $pkgname is not defined. Will try to use both $pkgname and $pkgdesc.
.sp
.B gendesk PKGBUILD
Looks for a PKGBUILD in the current directory and generates a .desktop file.
.sp
.B gendesk --pkgname test --pkgdesc test
Generates a .desktop file for the name "test" with the description "test".
.sp
.B gendesk /home/user/archpackages/mypackage/PKGBUILD
Generates a .desktop file from the given PKGBUILD.
.sp
A package name must be given, either by specifying a PKGBUILD file, using
\-\-pkgname or by defining a $pkgname environment variable.
.sp
Note that a "-bin", "-git", "-hg" or "-svn" suffix in a package name will be ignored, if present.
.PP
.SH OPTIONS
.TP
.B \-\-version
displays the current version information
.TP
.B \-h or \-\-help
displays brief usage information
.TP
.B \-n
don't attempt to download an icon, if missing
.TP
.B \-\-nocolor
don't use colored text
.TP
.B \-q
quiet; don't output text
.TP
.B \-f
force; overwrite files if needed
.TP
.B \-wm
generate a small desktop file for launching a window manager instead
.TP
.B \-\-pkgname
use this package name for the application (ie. emacs)
.TP
.B \-\-pkgdesc
use this package description for describing the application and try to find a suitable category
.TP
.B \-\-name
use this name for the desktop shortcut (ie. Emacs)
.TP
.B \-\-genericname
use this generic name for the desktop shortcut (ie. Text Editor)
.TP
.B \-\-comment
use this comment for the desktop shortcut (ie. Use this to edit files)
.TP
.B \-\-exec
specify an alternative executable, (ie. /usr/bin/emacs)
.TP
.B \-\-path
specify a starting path for the program, (ie. /usr/share/kotlin)
.TP
.B \-\-icon
specify an icon filename (defaults to the pkgname)
.TP
.B \-\-categories
specify categories (ie. Utility;TextEditor;)
.TP
.B \-\-terminal
specify if the application should be run in a terminal (default is false)
.TP
.B \-\-mimetypes
specify mime-types
.TP
.B \-\-startupnotify
specify if a desktop notification should occur when the application starts (default is false)
.TP
.B \-\-custom
specify an extra line (or several lines) to append at the end
.PP
.SH "WHY"
.sp
Aims to make it easy for package maintainers to add menu entries
for the applications they try to package, without including anything that
hasn't been supplied by upstream in the package itself.
.SH BUGS
Only unknown bugs so far. Bugs can be reported at https://github.com/xyproto/gendesk/issues.
.SH VERSION
1.0.8
.SH AUTHOR
.B gendesk
was written by Alexander F. Rødseth <xyproto@archlinux.org>