~allenap/maas/xxx-a-thon

« back to all changes in this revision

Viewing changes to man/maas.8

  • Committer: Gavin Panella
  • Date: 2012-11-22 23:39:27 UTC
  • mto: This revision was merged to the branch mainline in revision 1367.
  • Revision ID: gavin.panella@canonical.com-20121122233927-nz1gpwpkpvw336nb
Store generated man pages in the tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "MAAS" "8" "November 22, 2012" "12.10" "MAAS"
 
2
.SH NAME
 
3
maas \- MAAS administration tool
 
4
.
 
5
.nr rst2man-indent-level 0
 
6
.
 
7
.de1 rstReportMargin
 
8
\\$1 \\n[an-margin]
 
9
level \\n[rst2man-indent-level]
 
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
11
-
 
12
\\n[rst2man-indent0]
 
13
\\n[rst2man-indent1]
 
14
\\n[rst2man-indent2]
 
15
..
 
16
.de1 INDENT
 
17
.\" .rstReportMargin pre:
 
18
. RS \\$1
 
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
 
20
. nr rst2man-indent-level +1
 
21
.\" .rstReportMargin post:
 
22
..
 
23
.de UNINDENT
 
24
. RE
 
25
.\" indent \\n[an-margin]
 
26
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
27
.nr rst2man-indent-level -1
 
28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 
30
..
 
31
.\" Man page generated from reStructeredText.
 
32
.
 
33
.SH USAGE
 
34
.sp
 
35
maas  [\-h, \-\-help] createsuperuser | changepassword | shell
 
36
.SH DESCRIPTION
 
37
.sp
 
38
The \fImaas\fP command is part of Canonical\(aqs Metal As A Service software. It is
 
39
derived from and can be used similarly to the \fIdjango\-admin\fP command, and must
 
40
be run with root privileges.
 
41
.sp
 
42
For the end user, there are only three subcommands of interest.
 
43
.INDENT 0.0
 
44
.TP
 
45
.B \fBcreatesuperuser\fP
 
46
This subcommand is used to create a superuser for the
 
47
MAAS install. The suggested username is "root". This command usually only
 
48
needs to be run when installing MAAS for the first time.
 
49
.TP
 
50
.B \fBchangepassword\fP
 
51
This subcommand is used to change the superuser password
 
52
for the MAAS install. You will be prompted to enter a new password, and then
 
53
enter it once again to verify.
 
54
.TP
 
55
.B \fBshell\fP
 
56
This subcommand may be useful for debugging installed systems. It
 
57
will open a new python shell environment with the correct django environment
 
58
for working with the installed MAAS software.
 
59
.UNINDENT
 
60
.SH FURTHER DOCUMENTATION
 
61
.sp
 
62
For more documentation of MAAS, please see \fI\%https://maas.ubuntu.com/docs\fP
 
63
.SH SEE ALSO
 
64
.sp
 
65
\fImaas\-cli\fP
 
66
.SH AUTHOR
 
67
Canonical 2012
 
68
.SH COPYRIGHT
 
69
2012, MAAS Developers
 
70
.\" Generated by docutils manpage writer.
 
71
.\" 
 
72
.