summaryrefslogtreecommitdiff
path: root/scripts/man/xdg-su.1
blob: f50c8a37a894f70e31695c2a1a1ada10fef77bca (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
.\"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-SU" 1 "" "" "xdg-su Manual"
.SH NAME
xdg-su \- run a program as root after prompting for the root password
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 7
\fBxdg\-su\fR [\fB\-u\ \fIuser\fR\fR] \fB\-c\ \fIcommand\fR\fR
.ad
.hy
.ad l
.hy 0
.HP 7
\fBxdg\-su\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR}
.ad
.hy

.SH "DESCRIPTION"

.PP
xdg\-su provides a graphical dialog that prompts the user for a password to run \fIcommand\fR as \fIuser\fR or as root if no user was specified\&.

.PP
xdg\-su is for use inside a desktop session only\&.

.SH "OPTIONS"

.TP
\fB\-u \fIuser\fR\fR
run \fIcommand\fR as \fIuser\fR\&. The default is to run as root\&.

.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
\fBsu\fR(1) 

.SH "EXAMPLES"

.PP
 

.nf

xdg\-su \-u root \-c "/opt/shinythings/bin/install\-GUI \-\-install fast"

.fi
 Runs the /opt/shinythings/bin/install\-GUI command with root permissions\&.

.SH AUTHORS
Kevin Krammer, Jeremy White.