.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SUPYSONIC-CLI-USER" "1" "Dec 14, 2022" "0.7.2" "Supysonic"
.SH NAME
supysonic-cli-user \- Supysonic user management commands
.SH SYNOPSIS
.sp
supysonic\-cli user \fI\-\-help\fP
.sp
supysonic\-cli user \fBlist\fP
.sp
supysonic\-cli user \fBadd\fP <\fIuser\fP> [\fI\-\-password\fP <\fIpassword\fP>] [\fI\-\-email\fP <\fIemail\fP>]
.sp
supysonic\-cli user \fBdelete\fP <\fIuser\fP>
.sp
supysonic\-cli user \fBchangepass\fP <\fIuser\fP> [\fI\-\-password\fP <\fIpassword\fP>]
.sp
supysonic\-cli user \fBsetroles\fP [\fI\-\-admin\fP | \fI\-\-noadmin\fP] [\fI\-\-jukebox\fP | \fI\-\-nojukebox\fP] <\fIuser\fP>
.sp
supysonic\-cli user \fBrename\fP <\fIuser\fP> <\fInewname\fP>
.SH DESCRIPTION
.sp
The \fBsupysonic\-cli user\fP subcommand manages users, allowing to list them, add
a new user, delete an existing user, and change their password or roles.
.SH ARGUMENTS
.INDENT 0.0
.TP
\fBlist\fP
List all the users.
.TP
\fBadd\fP <\fIuser\fP> [\fI\-\-password\fP <\fIpassword\fP>] [\fI\-\-email\fP <\fIemail\fP>]
Add a new user named <\fIuser\fP>. Will prompt for a password if it isn\(aqt given
with the \fI\-\-password\fP option.
.TP
\fBdelete\fP <\fIuser\fP>
Delete the user <\fIuser\fP>.
.TP
\fBchangepass\fP <\fIuser\fP> [\fI\-\-password\fP <\fIpassword\fP>]
Change the password of user <\fIuser\fP>. Will prompt for the new password if
not provided.
.TP
\fBsetroles\fP [\fI\-\-admin\fP | \fI\-\-noadmin\fP] [\fI\-\-jukebox\fP | \fI\-\-nojukebox\fP] <\fIuser\fP>
Give or remove rights to user <\fIuser\fP>.
.TP
\fBrename\fP <\fIuser\fP> <\fInewname\fP>
Rename the user <\fIuser\fP> to <\fInewname\fP>.
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
\fB\-h\fP, \fB\-\-help\fP
Shows help and exits. Depending on where this option appears it will either
list the available commands or display help for a specific command.
.TP
\fB\-p\fP <\fIpassword\fP>, \fB\-\-password\fP <\fIpassword\fP>
Specify the user\(aqs password upon creation.
.TP
\fB\-e\fP <\fIemail\fP>, \fB\-\-email\fP <\fIemail\fP>
Specify the user\(aqs email.
.UNINDENT
.sp
The next options relate to user roles. They work in pairs, one option granting
a right while the other revokes it; obviously options of the same pair are
mutually exclusive.
.sp
The long options are named with the matching right, prefix it with a \fBno\fP to
revoke the right. For short options, the upper case letter grants the right
while the lower case letter revokes it. Short options might be combined into a
single one such as \fB\-aJ\fP to both revoke the admin right and grant the jukebox
one.
.INDENT 0.0
.TP
\fB\-A\fP, \fB\-\-admin\fP
Grant admin rights.
.TP
\fB\-a\fP, \fB\-\-noadmin\fP
Revoke admin rights.
.TP
\fB\-J\fP, \fB\-\-jukebox\fP
Grant jukebox rights.
.TP
\fB\-j\fP, \fB\-\-nojukebox\fP
Revoke jukebox rights.
.UNINDENT
.SH EXAMPLES
.sp
To add a new admin user named \fBMyUserName\fP having password
\fBMyAwesomePassword\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ supysonic\-cli user add MyUserName \-p MyAwesomePassword
$ supysonic\-cli user setroles \-A MyUserName
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBsupysonic\-cli (1)\fP, \fBsupysonic\-cli\-folder (1)\fP,
\fBsupysonic\-server (1)\fP, \fBsupysonic\-daemon (1)\fP
.SH AUTHOR
Louis-Philippe Véronneau, Alban Féron
.SH COPYRIGHT
2013-2022, Alban Féron
.\" Generated by docutils manpage writer.
.