desktop-file-install(1)

1DESKTOP-FILE-INSTALL(1)     General Commands Manual    DESKTOP-FILE-INSTALL(1)
2
3
4

NAME

6       desktop-file-install,  desktop-file-edit  - Installation and edition of
7       desktop files
8

SYNOPSIS

10       desktop-file-install [--dir=DIR] [-m  MODE|--mode=MODE]  [--vendor=VEN‐
11       DOR]  [--delete-original]  [--rebuild-mime-info-cache]  [EDITOPTION]...
12       FILE...
13
14       desktop-file-edit [EDITOPTION]... FILE
15

DESCRIPTION

17       The desktop-file-install program is a tool to install,  and  optionally
18       edit,  desktop files. The desktop-file-edit program is a tool to edit a
19       desktop file. They are mostly useful for developers and packagers.
20
21       Various options are available to  edit  the  desktop  files.  The  edit
22       options  can  be  specified more than once and will be processed in the
23       same order as the options passed to the program.
24
25       desktop-file-install and desktop-file-edit will always try to  validate
26       the  resulting  desktop  file.  A failure to validate might lead to the
27       abortion of the installation of the desktop files.
28
29       The list of registered categories and desktop environments  is  defined
30       in   the   Menu  specification:  http://freedesktop.org/wiki/Specifica‐
31       tions/menu-spec.
32

OPTIONS

34       The following options are supported:
35
36       --dir=DIR
37              Install desktop files to the DIR directory.
38
39       -m, --mode=MODE
40              Set the permissions of the destination files to MODE.
41
42       --vendor=VENDOR
43              Add a vendor prefix to the desktop files. If a file already  has
44              this  prefix, nothing happens; else, the file will be named VEN‐
45              DOR-FILE. For example: if VENDOR is freedesktop.org and FILE  is
46              specification.desktop,  the result file will be freedesktop.org-
47              specification.desktop.
48
49       --delete-original
50              Delete the source desktop files, leaving only the target  files.
51              Effectively "renames" the desktop files.
52
53       --rebuild-mime-info-cache
54              Rebuild the MIME types application database after installing the
55              desktop files. See  update-desktop-database(1)  for  information
56              about this database.
57

EDIT OPTIONS

59       The following edit options are supported:
60
61       --set-key=KEY
62              Set  the  KEY  key  to  the value passed to the next --set-value
63              option. A matching --set-value option is mandatory.
64
65       --set-value=VALUE
66              Set the key specified with  the  previous  --set-key  option  to
67              VALUE.  A matching --set-key option is mandatory.
68
69       --set-name=NAME
70              Set  the  name (key Name) to NAME. If a name was already set, it
71              will be overridden.  Localizations  of  the  old  name  will  be
72              removed.
73
74       --copy-name-to-generic-name
75              Copy the value of the Name key to the GenericName key. Note that
76              a desktop file requires a Name key to be valid, so  this  option
77              will always have an effect.
78
79       --set-generic-name=GENERIC-NAME
80              Set  the  generic  name  (key GenericName) to GENERIC-NAME. If a
81              generic name was already set, it will be  overridden.  Localiza‐
82              tions of the old generic name will be removed.
83
84       --copy-generic-name-to-name
85              Copy  the  value  of the GenericName key to the Name key, if the
86              GenericName key is present.
87
88       --set-comment=COMMENT
89              Set the comment (key Comment)  to  COMMENT.  If  a  comment  was
90              already  set,  it  will  be overridden. Localizations of the old
91              comment will be removed.
92
93       --set-icon=ICON
94              Set the icon (key Icon) to ICON. If an icon was already set,  it
95              will  be  overridden.  Localizations  of  the  old  icon will be
96              removed.
97
98       --add-category=CATEGORY
99              Add CATEGORY to the list of categories (key Categories). If CAT‐
100              EGORY  was  already present in the list, this operation is a no-
101              op. A non-registered category should be prefixed with X-.
102
103       --remove-category=CATEGORY
104              Remove CATEGORY from the list of categories (key Categories). If
105              CATEGORY was not present in the list, this operation is a no-op.
106
107       --add-mime-type=MIME-TYPE
108              Add MIME-TYPE to the list of MIME types (key MimeType). If MIME-
109              TYPE was already present in the list, this operation is a no-op.
110
111       --remove-mime-type=MIME-TYPE
112              Remove MIME-TYPE from the list of MIME types (key MimeType).  If
113              MIME-TYPE  was  not present in the list, this operation is a no-
114              op.
115
116       --add-only-show-in=ENVIRONMENT
117              Add ENVIRONMENT to the list of desktop  environments  where  the
118              desktop  files should be displayed (key OnlyShowIn). If ENVIRON‐
119              MENT was already present in the list, this operation is a no-op.
120              A non-registered desktop environment should be prefixed with X-.
121              Note that an empty OnlyShowIn key in a desktop file  means  that
122              the desktop file will be displayed in all environments.
123
124       --remove-only-show-in=ENVIRONMENT
125              Remove  ENVIRONMENT  from the list of desktop environments where
126              the desktop files should be displayed (key OnlyShowIn). If ENVI‐
127              RONMENT was not present in the list, this operation is a no-op.
128
129       --add-not-show-in=ENVIRONMENT
130              Add  ENVIRONMENT  to  the list of desktop environments where the
131              desktop files should not be displayed (key NotShowIn). If  ENVI‐
132              RONMENT was already present in the list, this operation is a no-
133              op. A non-registered desktop environment should be prefixed with
134              X-.  Note  that  an  empty NotShowIn key in a desktop file means
135              that the desktop file will be displayed in all environments.
136
137       --remove-not-show-in=ENVIRONMENT
138              Remove ENVIRONMENT from the list of desktop  environments  where
139              the  desktop  files  should not be displayed (key NotShowIn). If
140              ENVIRONMENT was not present in the list, this operation is a no-
141              op.
142
143       --remove-key=KEY
144              Remove the KEY key from the desktop files, if present.
145

ENVIRONMENT

147       Some environment variables change the behavior of desktop-file-install:
148
149       DESKTOP_FILE_VENDOR
150
151              This  variable  can  be  used  as an alternative to the --vendor
152              option. If the --vendor option is used, this  environment  vari‐
153              able will be ignored.
154
155       DESKTOP_FILE_INSTALL_DIR
156
157              This variable can be used as an alternative to the --dir option.
158              If the --dir option is used, this environment variable  will  be
159              ignored.
160
161       RPM_BUILD_ROOT
162
163              This  variable  is  set when building RPM packages. If the --dir
164              option and the DESKTOP_FILE_INSTALL_DIR environment variable are
165              not  used,  it  will  automatically  be prepended to the default
166              install directory to install  the  desktop  files  appropriately
167              when building packages.
168

BUGS

170       If  you  find  bugs  in the desktop-file-install program, please report
171       these on https://bugs.freedesktop.org.
172