summaryrefslogtreecommitdiff
path: root/scripts/man/xdg-icon.1
blob: 518481bbc8e5557333f2028f77efd9385e0d1848 (plain)
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "XDG-ICON" 1 "" "" "xdg-icon Manual"
.SH NAME
xdg-icon \- command line tool for (un)installing icons
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 9
\fBxdg\-icon\fR install [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] {\fB\fB\-\-user\fR\fR | \fB\fB\-\-system\fR\fR} \fIicon\-file\fR [\fIicon\-name\fR]
.ad
.hy
.ad l
.hy 0
.HP 9
\fBxdg\-icon\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] {\fB\fB\-\-user\fR\fR | \fB\fB\-\-system\fR\fR} \fIicon\-name\fR
.ad
.hy
.ad l
.hy 0
.HP 9
\fBxdg\-icon\fR forceupdate [\fB\-\-theme\ \fItheme\fR\fR] {\fB\-\-user\fR | \fB\-\-system\fR}
.ad
.hy
.ad l
.hy 0
.HP 9
\fBxdg\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR}
.ad
.hy

.SH "DESCRIPTION"

.PP
The xdg\-icon program can be used to install icons into the desktop icon system for use in menu entries, as desktop icons or as file icon\&.

.PP
The desktop icon system works according to the XDG Icon Theme Specification at http://www\&.freedesktop\&.org/Standards/icon\-theme\-\-spec

.SH "COMMANDS"

.TP
install
Installs the icon file indicated by \fIicon\-file\fR to the desktop icon system under the name \fIicon\-name\fR\&. If \fIicon\-name\fR is not provided the name is derived from \fIicon\-file\fR\&. The icon file must have \fI\&.png\fR, \fI\&.xpm\fR or \fI\&.svg\fR as extension\&. If a corresponding \fI\&.icon\fR file exists in the same location as \fIicon\-file\fR it will be installed as well\&.

.TP
uninstall
Removes the icon file indicated by \fIicon\-name\fR from the desktop icon system\&.

.TP
forceupdate
Force an update of the desktop icon system\&. This is only useful if the last call to xdg\-icon included the \fB\-\-noupdate\fR option\&.

.SH "OPTIONS"

.TP
\fB\-\-noupdate\fR
Postpone updating the desktop icon system\&. If multiple icons are added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away\&.

.TP
\fB\-\-theme\fR \fItheme\fR
Installs or removes the icon file as part of \fItheme\fR\&. If no theme is specified the icons will be installed as part of the default \fIhicolor\fR theme\&. Applications may install icons under multiple themes but should at least install icons for the default \fIhicolor\fR theme\&.

.TP
\fB\-\-context\fR \fIcontext\fR
Specifies the context for the icon\&. Icons to be used in the application menu and as desktop icon should use \fIapps\fR as context which is the default context\&. Icons to be used as file icons should use \fImimetypes\fR as context\&. Other common contexts are \fIactions\fR, \fIdevices\fR, \fIemblems\fR, \fIfilesystems\fR and \fIstock\fR\&.

.TP
\fB\-\-size\fR \fIsize\fR
Specifies the size of the icon (required for png and xpm icons)\&. All icons must be square\&. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128\&. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128

.TP
\fB\-\-user\fR
Installs or uninstalls the icon for the current user only\&.

.TP
\fB\-\-system\fR
Installs or uninstalls the icon for all users on the system\&. Usually only root is allowed to do this\&.

.TP
\fB\-\-help\fR
Show command synopsis\&.

.TP
\fB\-\-manual\fR
Show this manualpage\&.

.TP
\fB\-\-version\fR
Show the xdg\-utils version information\&.

.SH "EXIT CODES"

.PP
An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned:

.TP
\fB1\fR
Error in command line syntax\&.

.TP
\fB2\fR
One of the files passed on the command line did not exist\&.

.TP
\fB3\fR
A required tool could not be found\&.

.TP
\fB4\fR
The action failed\&.

.SH "SEE ALSO"

.PP
\fBxdg\-desktop\fR(1), \fBxdg\-menu\fR(1), \fBxdg\-mime\fR(1) 

.SH "EXAMPLES"

.PP
TBD

.SH AUTHORS
Kevin Krammer, Jeremy White.