Code

Ticket #3341: django-admin.2.1

File django-admin.2.1, 4.7 KB (added by Paul <pb@…>, 7 years ago)

revised django-admin.py manpage

Line 
1.TH "django-admin.py" "1" "June 2007" "Django Project" ""
2.SH "NAME"
3django\-admin.py \- Utility script for the Django web framework
4.SH "SYNOPSIS"
5.B django\-admin.py <
6.I action
7.B > [options]
8.sp
9.SH "DESCRIPTION"
10This utility script provides commands for creation and
11maintenance of Django projects and apps.
12.sp
13With the exception of
14.BI startproject,
15all commands listed below can also be performed with the
16.BI manage.py
17script found at the top level of each Django project directory.
18.sp
19.SH "ACTIONS"
20.TP
21.BI "adminindex [" "appname ..." "]"
22Prints the admin\-index template snippet for the given app name(s).
23.TP
24.BI "createcachetable [" "tablename" "]"
25Creates the table needed to use the SQL cache backend
26.TP
27.B dbshell
28Runs the command\-line client for the current
29.BI DATABASE_ENGINE.
30.TP
31.B diffsettings
32Displays differences between the current
33.B settings.py
34and Django's default settings. Settings that don't appear in the defaults are
35followed by "###".
36.TP
37.B inspectdb
38Introspects the database tables in the database specified in settings.py and outputs a Django
39model module.
40.TP
41.BI "install [" "appname ..." "]"
42Executes
43.B sqlall
44for the given app(s) in the current database.
45.TP
46.BI "reset [" "appname ..." "]"
47Executes
48.B sqlreset
49for the given app(s) in the current database.
50.TP
51.BI "runfcgi [" "KEY=val" "] [" "KEY=val" "] " "..."
52Runs this project as a FastCGI application. Requires flup. Use
53.B runfcgi help
54for help on the KEY=val pairs.
55.TP
56.BI "runserver [" "\-\-noreload" "] [" "\-\-adminmedia=ADMIN_MEDIA_PATH" "] [" "port|ipaddr:port" "]"
57Starts a lightweight Web server for development.
58.TP
59.BI "shell [" "\-\-plain" "]"
60Runs a Python interactive interpreter. Tries to use IPython, if it's available. The
61.BI \-\-plain
62option forces the use of the standard Python interpreter even when IPython is installed.
63.TP
64.BI "sql [" "appname ..." "]"
65Prints the CREATE TABLE SQL statements for the given app name(s).
66.TP
67.BI "sqlall [" "appname ..." "]"
68Prints the CREATE TABLE, initial\-data and CREATE INDEX SQL statements for the
69given model module name(s).
70.TP
71.BI "sqlclear [" "appname ..." "]"
72Prints the DROP TABLE SQL statements for the given app name(s).
73.TP
74.BI "sqlindexes [" "appname ..." "]"
75Prints the CREATE INDEX SQL statements for the given model module name(s).
76.TP
77.BI "sqlinitialdata [" "appname ..." "]"
78Prints the initial INSERT SQL statements for the given app name(s).
79.TP
80.BI "sqlreset [" "appname ..." "]"
81Prints the DROP TABLE SQL, then the CREATE TABLE SQL, for the given app
82name(s).
83.TP
84.BI "sqlsequencereset [" "appname ..." "]"
85Prints the SQL statements for resetting PostgreSQL sequences for the
86given app name(s).
87.TP
88.BI "startapp [" "appname" "]"
89Creates a Django app directory structure for the given app name in
90the current directory.
91.TP
92.BI "startproject [" "projectname" "]"
93Creates a Django project directory structure for the given project name
94in the current directory.
95.TP
96.BI syncdb
97Creates the database tables for all apps in INSTALLED_APPS whose tables
98haven't already been created.
99.TP
100.BI "test [" "\-\-verbosity" "] [" "appname ..." "]"
101Runs the test suite for the specified applications, or the entire project if
102no apps are specified
103.TP
104.BI validate
105Validates all installed models.
106.SH "OPTIONS"
107.TP
108.I \-\-version
109Show program's version number and exit.
110.TP
111.I \-h, \-\-help
112Show this help message and exit.
113.TP
114.I \-\-settings=SETTINGS
115Python path to settings module, e.g. "myproject.settings.main". If
116this isn't provided, the DJANGO_SETTINGS_MODULE environment variable
117will be used.
118.TP
119.I \-\-pythonpath=PYTHONPATH
120Lets you manually add a directory the Python path,
121e.g. "/home/djangoprojects/myproject".
122.TP
123.I \-\-plain
124Use plain Python, not IPython, for the "shell" command.
125.TP
126.I \-\-noinput
127Do not prompt the user for input.
128.TP
129.I \-\-noreload
130Disable the development server's auto\-reloader.
131.TP
132.I \-\-verbosity=VERBOSITY
133Verbosity level: 0=minimal output, 1=normal output, 2=all output.
134.TP
135.I \-\-adminmedia=ADMIN_MEDIA_PATH
136Specifies the directory from which to serve admin media when using the development server.
137
138.SH "ENVIRONMENT"
139.TP
140.I DJANGO_SETTINGS_MODULE
141In the absence of the
142.BI \-\-settings
143option, this environment variable defines the settings module to be read.
144It should be in Python-import form, e.g. "myproject.settings".
145
146.SH "SEE ALSO"
147Full descriptions of all these options, with examples, as well as documentation
148for the rest of the Django framework, can be found on the Django site:
149.sp
150.I http://www.djangoproject.com/documentation/
151.sp
152.SH "AUTHORS/CREDITS"
153Originally developed at World Online in Lawrence, Kansas, USA.
154Refer to the AUTHORS file in the Django distribution for contributors.
155.sp
156.SH "LICENSE"
157BSD license. For the full license text refer to the LICENSE file
158in the Django distribution.