mirror of
https://github.com/django/django.git
synced 2024-12-27 19:46:22 +00:00
c81fae6b95
The last component of the dotted path to the application module is consistently referenced as the application "label". For instance it's AppConfig.label. appname could be confused with AppConfig.name, which is the full dotted path.
239 lines
8.2 KiB
Groff
239 lines
8.2 KiB
Groff
.TH "django-admin.py" "1" "March 2008" "Django Project" ""
|
|
.SH "NAME"
|
|
django\-admin.py \- Utility script for the Django Web framework
|
|
.SH "SYNOPSIS"
|
|
.B django\-admin.py
|
|
.I <action>
|
|
.B [options]
|
|
.sp
|
|
.SH "DESCRIPTION"
|
|
This utility script provides commands for creation and maintenance of Django
|
|
projects and apps.
|
|
.sp
|
|
With the exception of
|
|
.BI startproject,
|
|
all commands listed below can also be performed with the
|
|
.BI manage.py
|
|
script found at the top level of each Django project directory.
|
|
.sp
|
|
.SH "ACTIONS"
|
|
.TP
|
|
.BI cleanup
|
|
Cleans out old data from the database (only expired sessions at the moment).
|
|
.TP
|
|
.BI "compilemessages [" "\-\-locale=LOCALE" "]"
|
|
Compiles .po files to .mo files for use with builtin gettext support.
|
|
.TP
|
|
.BI "createcachetable [" "tablename" "]"
|
|
Creates the table needed to use the SQL cache backend
|
|
.TP
|
|
.BI "createsuperuser [" "\-\-username=USERNAME" "] [" "\-\-email=EMAIL" "]"
|
|
Creates a superuser account (a user who has all permissions).
|
|
.TP
|
|
.B dbshell
|
|
Runs the command\-line client for the specified
|
|
.BI database ENGINE.
|
|
.TP
|
|
.B diffsettings
|
|
Displays differences between the current
|
|
.B settings.py
|
|
and Django's default settings. Settings that don't appear in the defaults are
|
|
followed by "###".
|
|
.TP
|
|
.BI "dumpdata [" "\-\-all" "] [" "\-\-format=FMT" "] [" "\-\-indent=NUM" "] [" "\-\-natural=NATURAL" "] [" "app_label app_label app_label.Model ..." "]"
|
|
Outputs to standard output all data in the database associated with the named
|
|
application(s).
|
|
.TP
|
|
.BI flush
|
|
Removes all data from the database and then re-installs any initial data.
|
|
.TP
|
|
.B inspectdb
|
|
Introspects the database tables in the database specified in settings.py and outputs a Django
|
|
model module.
|
|
.TP
|
|
.BI "loaddata [" "fixture fixture ..." "]"
|
|
Searches for and loads the contents of the named fixture into the database.
|
|
.TP
|
|
.BI "install [" "app_label ..." "]"
|
|
Executes
|
|
.B sqlall
|
|
for the given app(s) in the current database.
|
|
.TP
|
|
.BI "makemessages [" "\-\-locale=LOCALE" "] [" "\-\-domain=DOMAIN" "] [" "\-\-extension=EXTENSION" "] [" "\-\-all" "] [" "\-\-symlinks" "] [" "\-\-ignore=PATTERN" "] [" "\-\-no\-default\-ignore" "] [" "\-\-no\-wrap" "] [" "\-\-no\-location" "]"
|
|
Runs over the entire source tree of the current directory and pulls out all
|
|
strings marked for translation. It creates (or updates) a message file in the
|
|
conf/locale (in the django tree) or locale (for project and application) directory.
|
|
.TP
|
|
.BI "runfcgi [" "KEY=val" "] [" "KEY=val" "] " "..."
|
|
Runs this project as a FastCGI application. Requires flup. Use
|
|
.B runfcgi help
|
|
for help on the KEY=val pairs.
|
|
.TP
|
|
.BI "runserver [" "\-\-noreload" "] [" "\-\-nothreading" "] [" "\-\-nostatic" "] [" "\-\-insecure" "] [" "\-\-ipv6" "] [" "port|ipaddr:port" "]"
|
|
Starts a lightweight Web server for development.
|
|
.TP
|
|
.BI "shell [" "\-\-plain" "]"
|
|
Runs a Python interactive interpreter. Tries to use IPython, if it's available.
|
|
The
|
|
.BI \-\-plain
|
|
option forces the use of the standard Python interpreter even when IPython is
|
|
installed.
|
|
.TP
|
|
.BI "sql [" "app_label ..." "]"
|
|
Prints the CREATE TABLE SQL statements for the given app name(s).
|
|
.TP
|
|
.BI "sqlall [" "app_label ..." "]"
|
|
Prints the CREATE TABLE, initial\-data and CREATE INDEX SQL statements for the
|
|
given model module name(s).
|
|
.TP
|
|
.BI "sqlclear [" "app_label ..." "]"
|
|
Prints the DROP TABLE SQL statements for the given app name(s).
|
|
.TP
|
|
.BI "sqlcustom [" "app_label ..." "]"
|
|
Prints the custom SQL statements for the given app name(s).
|
|
.TP
|
|
.BI "sqlflush [" "app_label ..." "]"
|
|
Prints the SQL statements that would be executed for the "flush" command.
|
|
.TP
|
|
.BI "sqlindexes [" "app_label ..." "]"
|
|
Prints the CREATE INDEX SQL statements for the given model module name(s).
|
|
.TP
|
|
.BI "sqlinitialdata [" "app_label ..." "]"
|
|
Prints the initial INSERT SQL statements for the given app name(s).
|
|
.TP
|
|
.BI "sqlsequencereset [" "app_label ..." "]"
|
|
Prints the SQL statements for resetting PostgreSQL sequences for the
|
|
given app name(s).
|
|
.TP
|
|
.BI "startapp [" "\-\-template=PATH_OR_URL" "] [" "\-\-extension=EXTENSION" "] [" "\-\-name=FILENAME" "] [" "app_label" "] [" "destination" "]"
|
|
Creates a Django app directory structure for the given app name in
|
|
the current directory or the optional destination.
|
|
.TP
|
|
.BI "startproject [" "\-\-template=PATH_OR_URL" "] [" "\-\-extension=EXTENSION" "] [" "\-\-name=FILENAME" "] [" "projectname" "] [" "destination" "]"
|
|
Creates a Django project directory structure for the given project name
|
|
in the current directory or the optional destination.
|
|
.TP
|
|
.BI migrate
|
|
Runs migrations for apps containing migrations, and just creates missing tables
|
|
for apps without migrations.
|
|
.TP
|
|
.BI "test [" "\-\-verbosity" "] [" "\-\-failfast" "] [" "app_label ..." "]"
|
|
Runs the test suite for the specified applications, or the entire project if
|
|
no apps are specified
|
|
.TP
|
|
.BI "testserver [" "\-\-addrport=ipaddr|port" "] [" "fixture fixture ..." "]"
|
|
Runs the test suite for the specified applications, or the entire project if
|
|
no apps are specified
|
|
.TP
|
|
.BI validate
|
|
Validates all installed models.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.I \-\-version
|
|
Show program's version number and exit.
|
|
.TP
|
|
.I \-h, \-\-help
|
|
Show this help message and exit.
|
|
.TP
|
|
.I \-\-settings=SETTINGS
|
|
Python path to settings module, e.g. "myproject.settings.main". If
|
|
this isn't provided, the DJANGO_SETTINGS_MODULE environment variable
|
|
will be used.
|
|
.TP
|
|
.I \-\-pythonpath=PYTHONPATH
|
|
Lets you manually add a directory the Python path,
|
|
e.g. "/home/djangoprojects/myproject".
|
|
.TP
|
|
.I \-\-plain
|
|
Use plain Python, not IPython, for the "shell" command.
|
|
.TP
|
|
.I \-\-noinput
|
|
Do not prompt the user for input.
|
|
.TP
|
|
.I \-\-noreload
|
|
Disable the development server's auto\-reloader.
|
|
.TP
|
|
.I \-\-nostatic
|
|
Disable automatic serving of static files from STATIC_URL.
|
|
.TP
|
|
.I \-\-nothreading
|
|
Disable the development server's threading.
|
|
.TP
|
|
.I \-\-insecure
|
|
Enables serving of static files even if DEBUG is False.
|
|
.TP
|
|
.I \-\-ipv6
|
|
Enables IPv6 addresses.
|
|
.TP
|
|
.I \-\-verbosity=VERBOSITY
|
|
Verbosity level: 0=minimal output, 1=normal output, 2=all output.
|
|
.TP
|
|
.I \-\-traceback
|
|
By default, django-admin.py will show a simple error message whenever an
|
|
error occurs. If you specify this option, django-admin.py will
|
|
output a full stack trace whenever an exception is raised.
|
|
.TP
|
|
.I \-l, \-\-locale=LOCALE
|
|
The locale to process when using makemessages or compilemessages.
|
|
.TP
|
|
.I \-d, \-\-domain=DOMAIN
|
|
The domain of the message files (default: "django") when using makemessages.
|
|
.TP
|
|
.I \-e, \-\-extension=EXTENSION
|
|
The file extension(s) to examine (separate multiple
|
|
extensions with commas, or use \-e multiple times) (makemessages command).
|
|
.TP
|
|
.I \-s, \-\-symlinks
|
|
Follows symlinks to directories when examining source code and templates for
|
|
translation strings (makemessages command).
|
|
.TP
|
|
.I \-i, \-\-ignore=PATTERN
|
|
Ignore files or directories matching this glob-style pattern. Use multiple
|
|
times to ignore more (makemessages command).
|
|
.TP
|
|
.I \-\-no\-default\-ignore
|
|
Don't ignore the common private glob-style patterns 'CVS', '.*', '*~' and '*.pyc'
|
|
(makemessages command).
|
|
.TP
|
|
.I \-\-no\-wrap
|
|
Don't break long message lines into several lines (makemessages command).
|
|
.TP
|
|
.I \-\-no\-location
|
|
Don't write '#: filename:line' comment lines in language files (makemessages command).
|
|
.TP
|
|
.I \-a, \-\-all
|
|
Process all available locales when using makemessages.
|
|
.TP
|
|
.I \-\-template=PATH_OR_URL
|
|
The file or directory path or URL to load the project and app templates from.
|
|
.TP
|
|
.I \-n, \-\-name=FILENAME
|
|
The name of an additional file to render when using app and project templates.
|
|
.TP
|
|
.I \-\-database=DB
|
|
Used to specify the database on which a command will operate. If not
|
|
specified, this option will default to an alias of "default".
|
|
.SH "ENVIRONMENT"
|
|
.TP
|
|
.I DJANGO_SETTINGS_MODULE
|
|
In the absence of the
|
|
.BI \-\-settings
|
|
option, this environment variable defines the settings module to be read.
|
|
It should be in Python-import form, e.g. "myproject.settings".
|
|
|
|
.SH "SEE ALSO"
|
|
Full descriptions of all these options, with examples, as well as documentation
|
|
for the rest of the Django framework, can be found on the Django site:
|
|
.sp
|
|
.I http://docs.djangoproject.com/en/dev/
|
|
.sp
|
|
or in the distributed documentation.
|
|
.SH "AUTHORS/CREDITS"
|
|
Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
|
|
AUTHORS file in the Django distribution for contributors.
|
|
.sp
|
|
.SH "LICENSE"
|
|
New BSD license. For the full license text refer to the LICENSE file in the
|
|
Django distribution.
|
|
|