summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2017-01-17 19:20:49 -0500
committerTim Graham <timograham@gmail.com>2017-01-17 19:20:49 -0500
commit792c13fbba1d5272d337d25b141b1cf4264df795 (patch)
tree2a424c9b37f9ef4d83830206a059729a0f390971
parent4eb4453dac8cb5b5c06cf3e91129f8fc2f943936 (diff)
[1.11.x] Updated man page for Django 1.11 alpha.
-rw-r--r--docs/man/django-admin.11210
1 files changed, 643 insertions, 567 deletions
diff --git a/docs/man/django-admin.1 b/docs/man/django-admin.1
index 3f07cc0e7a..bd0f7c5eac 100644
--- a/docs/man/django-admin.1
+++ b/docs/man/django-admin.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "DJANGO-ADMIN" "1" "September 23, 2015" "1.9" "Django"
+.TH "DJANGO-ADMIN" "1" "January 17, 2017" "1.11" "Django"
.SH NAME
django-admin \- Utility script for the Django Web framework
.
@@ -35,16 +35,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
This document outlines all it can do.
.sp
In addition, \fBmanage.py\fP is automatically created in each Django project.
-\fBmanage.py\fP is a thin wrapper around \fBdjango\-admin\fP that takes care of
-several things for you before delegating to \fBdjango\-admin\fP:
+\fBmanage.py\fP does the same thing as \fBdjango\-admin\fP but takes care of a few
+things for you:
.INDENT 0.0
.IP \(bu 2
It puts your project\(aqs package on \fBsys.path\fP\&.
.IP \(bu 2
It sets the \fBDJANGO_SETTINGS_MODULE\fP environment variable so that
it points to your project\(aqs \fBsettings.py\fP file.
-.IP \(bu 2
-It calls \fBdjango.setup()\fP to initialize various internals of Django.
.UNINDENT
.sp
The \fBdjango\-admin\fP script should be on your system path if you installed
@@ -66,9 +64,6 @@ option.
The command\-line examples throughout this document use \fBdjango\-admin\fP to
be consistent, but any example can use \fBmanage.py\fP or \fBpython \-m django\fP
just as well.
-.sp
-\fBpython \-m django\fP was added.
-
.SH USAGE
.INDENT 0.0
.INDENT 3.5
@@ -113,7 +108,7 @@ contains the string \fB\(aqmysite.blog\(aq\fP, the app name is \fBblog\fP\&.
.sp
Run \fBdjango\-admin version\fP to display the current Django version.
.sp
-The output follows the schema described in \fI\%PEP 386\fP:
+The output follows the schema described in \fI\%PEP 440\fP:
.INDENT 0.0
.INDENT 3.5
.sp
@@ -128,32 +123,26 @@ The output follows the schema described in \fI\%PEP 386\fP:
.UNINDENT
.SS Displaying debug output
.sp
-Use \fI\%\-\-verbosity\fP to specify the amount of notification and debug information
-that \fBdjango\-admin\fP should print to the console. For more details, see the
-documentation for the \fI\%\-\-verbosity\fP option.
+Use \fI\%\-\-verbosity\fP to specify the amount of notification and debug
+information that \fBdjango\-admin\fP prints to the console.
.SH AVAILABLE COMMANDS
-.SS check <appname appname ...>
+.SS \fBcheck\fP
.INDENT 0.0
.TP
-.B django\-admin check
+.B django\-admin check [app_label [app_label ...]]
.UNINDENT
.sp
-Uses the \fBsystem check framework\fP to inspect
-the entire Django project for common problems.
-.sp
-The system check framework will confirm that there aren\(aqt any problems with
-your installed models or your admin registrations. It will also provide warnings
-of common compatibility problems introduced by upgrading Django to a new version.
-Custom checks may be introduced by other libraries and applications.
+Uses the system check framework to inspect the entire
+Django project for common problems.
.sp
-By default, all apps will be checked. You can check a subset of apps by providing
-a list of app labels as arguments:
+By default, all apps will be checked. You can check a subset of apps by
+providing a list of app labels as arguments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-python manage.py check auth admin myapp
+django\-admin check auth admin myapp
.ft P
.fi
.UNINDENT
@@ -162,19 +151,19 @@ python manage.py check auth admin myapp
If you do not specify any app, all apps will be checked.
.INDENT 0.0
.TP
-.B \-\-tag <tagname>
+.B \-\-tag TAGS, \-t TAGS
.UNINDENT
.sp
-The \fBsystem check framework\fP performs many different
-types of checks. These check types are categorized with tags. You can use these tags
-to restrict the checks performed to just those in a particular category. For example,
-to perform only security and compatibility checks, you would run:
+The system check framework performs many different types of checks that are
+categorized with tags\&. You can use these
+tags to restrict the checks performed to just those in a particular category.
+For example, to perform only models and compatibility checks, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-python manage.py check \-\-tag security \-\-tag compatibility
+django\-admin check \-\-tag models \-\-tag compatibility
.ft P
.fi
.UNINDENT
@@ -184,16 +173,13 @@ python manage.py check \-\-tag security \-\-tag compatibility
.B \-\-list\-tags
.UNINDENT
.sp
-List all available tags.
+Lists all available tags.
.INDENT 0.0
.TP
.B \-\-deploy
.UNINDENT
.sp
-
-.sp
-The \fB\-\-deploy\fP option activates some additional checks that are only relevant
-in a deployment setting.
+Activates some additional checks that are only relevant in a deployment setting.
.sp
You can use this option in your local development environment, but since your
local development settings module may not have many of your production settings,
@@ -205,7 +191,7 @@ or by passing the \fB\-\-settings\fP option:
.sp
.nf
.ft C
-python manage.py check \-\-deploy \-\-settings=production_settings
+django\-admin check \-\-deploy \-\-settings=production_settings
.ft P
.fi
.UNINDENT
@@ -214,31 +200,42 @@ python manage.py check \-\-deploy \-\-settings=production_settings
Or you could run it directly on a production or staging deployment to verify
that the correct settings are in use (omitting \fB\-\-settings\fP). You could even
make it part of your integration test suite.
-.SS compilemessages
.INDENT 0.0
.TP
-.B django\-admin compilemessages
+.B \-\-fail\-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}
.UNINDENT
.sp
-Compiles .po files created by \fI\%makemessages\fP to .mo files for use with
-the builtin gettext support. See \fB/topics/i18n/index\fP\&.
+
.sp
-Use the \fI\%\-\-locale\fP option (or its shorter version \fB\-l\fP) to
-specify the locale(s) to process. If not provided, all locales are processed.
+Specifies the message level that will cause the command to exit with a non\-zero
+status. Default is \fBERROR\fP\&.
+.SS \fBcompilemessages\fP
+.INDENT 0.0
+.TP
+.B django\-admin compilemessages
+.UNINDENT
.sp
-Use the \fI\%\-\-exclude\fP option (or its shorter version \fB\-x\fP) to
-specify the locale(s) to exclude from processing. If not provided, no locales
-are excluded.
+Compiles \fB\&.po\fP files created by \fI\%makemessages\fP to \fB\&.mo\fP files for
+use with the built\-in gettext support. See /topics/i18n/index\&.
+.INDENT 0.0
+.TP
+.B \-\-locale LOCALE, \-l LOCALE
+.UNINDENT
.sp
-You can pass \fB\-\-use\-fuzzy\fP option (or \fB\-f\fP) to include fuzzy translations
-into compiled files.
+Specifies the locale(s) to process. If not provided, all locales are processed.
+.INDENT 0.0
+.TP
+.B \-\-exclude EXCLUDE, \-x EXCLUDE
+.UNINDENT
.sp
-\fBcompilemessages\fP now matches the operation of \fI\%makemessages\fP,
-scanning the project tree for \fB\&.po\fP files to compile.
-
+Specifies the locale(s) to exclude from processing. If not provided, no locales
+are excluded.
+.INDENT 0.0
+.TP
+.B \-\-use\-fuzzy, \-f
+.UNINDENT
.sp
-Added \fB\-\-exclude\fP and \fB\-\-use\-fuzzy\fP options.
-
+Includes fuzzy translations into compiled files.
.sp
Example usage:
.INDENT 0.0
@@ -258,34 +255,38 @@ django\-admin compilemessages \-x pt_BR \-x fr
.fi
.UNINDENT
.UNINDENT
-.SS createcachetable
+.SS \fBcreatecachetable\fP
.INDENT 0.0
.TP
.B django\-admin createcachetable
.UNINDENT
.sp
Creates the cache tables for use with the database cache backend using the
-information from your settings file. See \fB/topics/cache\fP for more
+information from your settings file. See /topics/cache for more
information.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option can be used to specify the database
-onto which the cache table will be installed, but since this information is
-pulled from your settings by default, it\(aqs typically not needed.
-.sp
-The \fI\%\-\-dry\-run\fP option will print the SQL that would be run without
-actually running it, so you can customize it or use the migrations framework.
+Specifies the database in which the cache table(s) will be created. Defaults to
+\fBdefault\fP\&.
+.INDENT 0.0
+.TP
+.B \-\-dry\-run
+.UNINDENT
.sp
-The \fB\-\-dry\-run\fP option was added.
-
-.SS dbshell
+Prints the SQL that would be run without actually running it, so you can
+customize it or use the migrations framework.
+.SS \fBdbshell\fP
.INDENT 0.0
.TP
.B django\-admin dbshell
.UNINDENT
.sp
Runs the command\-line client for the database engine specified in your
-\fBENGINE\fP setting, with the connection parameters specified in your
-\fBUSER\fP, \fBPASSWORD\fP, etc., settings.
+\fBENGINE\fP setting, with the connection parameters
+specified in your \fBUSER\fP, \fBPASSWORD\fP, etc., settings.
.INDENT 0.0
.IP \(bu 2
For PostgreSQL, this runs the \fBpsql\fP command\-line client.
@@ -301,29 +302,45 @@ This command assumes the programs are on your \fBPATH\fP so that a simple call t
the program name (\fBpsql\fP, \fBmysql\fP, \fBsqlite3\fP, \fBsqlplus\fP) will find the
program in the right place. There\(aqs no way to specify the location of the
program manually.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option can be used to specify the database
-onto which to open a shell.
-.SS diffsettings
+Specifies the database onto which to open a shell. Defaults to \fBdefault\fP\&.
+.SS \fBdiffsettings\fP
.INDENT 0.0
.TP
.B django\-admin diffsettings
.UNINDENT
.sp
Displays differences between the current settings file and Django\(aqs default
-settings.
+settings (or another settings file specified by \fI\%\-\-default\fP).
.sp
Settings that don\(aqt appear in the defaults are followed by \fB"###"\fP\&. For
example, the default settings don\(aqt define \fBROOT_URLCONF\fP, so
\fBROOT_URLCONF\fP is followed by \fB"###"\fP in the output of
\fBdiffsettings\fP\&.
+.INDENT 0.0
+.TP
+.B \-\-all
+.UNINDENT
+.sp
+Displays all settings, even if they have Django\(aqs default value. Such settings
+are prefixed by \fB"###"\fP\&.
+.INDENT 0.0
+.TP
+.B \-\-default MODULE
+.UNINDENT
+.sp
+
.sp
-The \fI\%\-\-all\fP option may be provided to display all settings, even
-if they have Django\(aqs default value. Such settings are prefixed by \fB"###"\fP\&.
-.SS dumpdata <app_label app_label app_label.Model ...>
+The settings module to compare the current settings against. Leave empty to
+compare against Django\(aqs default settings.
+.SS \fBdumpdata\fP
.INDENT 0.0
.TP
-.B django\-admin dumpdata
+.B django\-admin dumpdata [app_label[.ModelName] [app_label[.ModelName] ...]]
.UNINDENT
.sp
Outputs to standard output all data in the database associated with the named
@@ -337,78 +354,92 @@ Note that \fBdumpdata\fP uses the default manager on the model for selecting the
records to dump. If you\(aqre using a custom manager as
the default manager and it filters some of the available records, not all of the
objects will be dumped.
+.INDENT 0.0
+.TP
+.B \-\-all, \-a
+.UNINDENT
.sp
-The \fI\%\-\-all\fP option may be provided to specify that
-\fBdumpdata\fP should use Django\(aqs base manager, dumping records which
-might otherwise be filtered or modified by a custom manager.
+Uses Django\(aqs base manager, dumping records which might otherwise be filtered
+or modified by a custom manager.
.INDENT 0.0
.TP
-.B \-\-format <fmt>
+.B \-\-format FORMAT
.UNINDENT
.sp
-By default, \fBdumpdata\fP will format its output in JSON, but you can use the
-\fB\-\-format\fP option to specify another format. Currently supported formats
-are listed in serialization\-formats\&.
+Specifies the serialization format of the output. Defaults to JSON. Supported
+formats are listed in serialization\-formats\&.
.INDENT 0.0
.TP
-.B \-\-indent <num>
+.B \-\-indent INDENT
.UNINDENT
.sp
-By default, \fBdumpdata\fP will output all data on a single line. This isn\(aqt
-easy for humans to read, so you can use the \fB\-\-indent\fP option to
-pretty\-print the output with a number of indentation spaces.
+Specifies the number of indentation spaces to use in the output. Defaults to
+\fBNone\fP which displays all data on single line.
+.INDENT 0.0
+.TP
+.B \-\-exclude EXCLUDE, \-e EXCLUDE
+.UNINDENT
.sp
-The \fI\%\-\-exclude\fP option may be provided to prevent specific
-applications or models (specified as in the form of \fBapp_label.ModelName\fP)
-from being dumped. If you specify a model name to \fBdumpdata\fP, the dumped
+Prevents specific applications or models (specified in the form of
+\fBapp_label.ModelName\fP) from being dumped. If you specify a model name, the
output will be restricted to that model, rather than the entire application.
You can also mix application names and model names.
.sp
-The \fI\%\-\-database\fP option can be used to specify the database
-from which data will be dumped.
+If you want to exclude multiple applications, pass \fB\-\-exclude\fP more than
+once:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+django\-admin dumpdata \-\-exclude=auth \-\-exclude=contenttypes
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
+.sp
+Specifies the database from which data will be dumped. Defaults to \fBdefault\fP\&.
.INDENT 0.0
.TP
.B \-\-natural\-foreign
.UNINDENT
.sp
-When this option is specified, Django will use the \fBnatural_key()\fP model
-method to serialize any foreign key and many\-to\-many relationship to objects of
-the type that defines the method. If you are dumping \fBcontrib.auth\fP
-\fBPermission\fP objects or \fBcontrib.contenttypes\fP \fBContentType\fP objects, you
-should probably be using this flag. See the natural keys documentation for more details on this
-and the next option.
+Uses the \fBnatural_key()\fP model method to serialize any foreign key and
+many\-to\-many relationship to objects of the type that defines the method. If
+you\(aqre dumping \fBcontrib.auth\fP \fBPermission\fP objects or
+\fBcontrib.contenttypes\fP \fBContentType\fP objects, you should probably use this
+flag. See the natural keys
+documentation for more details on this and the next option.
.INDENT 0.0
.TP
.B \-\-natural\-primary
.UNINDENT
.sp
-When this option is specified, Django will not provide the primary key in the
-serialized data of this object since it can be calculated during
-deserialization.
+Omits the primary key in the serialized data of this object since it can be
+calculated during deserialization.
.INDENT 0.0
.TP
-.B \-\-pks
+.B \-\-pks PRIMARY_KEYS
.UNINDENT
.sp
-By default, \fBdumpdata\fP will output all the records of the model, but
-you can use the \fB\-\-pks\fP option to specify a comma separated list of
-primary keys on which to filter. This is only available when dumping
-one model.
+Outputs only the objects specified by a comma separated list of primary keys.
+This is only available when dumping one model. By default, all the records of
+the model are output.
.INDENT 0.0
.TP
-.B \-\-output
+.B \-\-output OUTPUT, \-o OUTPUT
.UNINDENT
.sp
-
+Specifies a file to write the serialized data to. By default, the data goes to
+standard output.
.sp
-By default \fBdumpdata\fP will output all the serialized data to standard output.
-This option allows you to specify the file to which the data is to be written.
-When this option is set and the verbosity is greater than 0 (the default), a
+When this option is set and \fB\-\-verbosity\fP is greater than 0 (the default), a
progress bar is shown in the terminal.
-.sp
-The progress bar in the terminal was added.
-
-.SS flush
+.SS \fBflush\fP
.INDENT 0.0
.TP
.B django\-admin flush
@@ -419,21 +450,28 @@ handlers. The table of which migrations have been applied is not cleared.
.sp
If you would rather start from an empty database and re\-run all migrations, you
should drop and recreate the database and then run \fI\%migrate\fP instead.
+.INDENT 0.0
+.TP
+.B \-\-noinput, \-\-no\-input
+.UNINDENT
.sp
-The \fI\%\-\-noinput\fP option may be provided to suppress all user
-prompts.
+Suppresses all user prompts.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option may be used to specify the database
-to flush.
-.SS inspectdb
+Specifies the database to flush. Defaults to \fBdefault\fP\&.
+.SS \fBinspectdb\fP
.INDENT 0.0
.TP
-.B django\-admin inspectdb
+.B django\-admin inspectdb [table [table ...]]
.UNINDENT
.sp
Introspects the database tables in the database pointed\-to by the
\fBNAME\fP setting and outputs a Django model module (a \fBmodels.py\fP
-file) to standard output.
+file) to standard output. You may choose what tables to inspect by passing
+their names as arguments.
.sp
Use this if you have a legacy database with which you\(aqd like to use Django.
The script will inspect the database and create a model for each table within
@@ -483,35 +521,52 @@ table\(aqs lifecycle, you\(aqll need to change the
\fBmanaged\fP option to \fBTrue\fP (or simply remove
it because \fBTrue\fP is its default value).
.sp
-The \fI\%\-\-database\fP option may be used to specify the
-database to introspect.
-.SS loaddata <fixture fixture ...>
+Support for the \fBtable\fP argument(s) to choose what tables should be
+inspected was added.
+
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
+.sp
+Specifies the database to introspect. Defaults to \fBdefault\fP\&.
+.SS \fBloaddata\fP
.INDENT 0.0
.TP
-.B django\-admin loaddata
+.B django\-admin loaddata fixture [fixture ...]
.UNINDENT
.sp
Searches for and loads the contents of the named fixture into the database.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option can be used to specify the database
-onto which the data will be loaded.
+Specifies the database into which the data will be loaded. Defaults to
+\fBdefault\fP\&.
.INDENT 0.0
.TP
-.B \-\-ignorenonexistent
+.B \-\-ignorenonexistent, \-i
.UNINDENT
.sp
-The \fI\%\-\-ignorenonexistent\fP option can be used to ignore fields and
-models that may have been removed since the fixture was originally generated.
+Ignores fields and models that may have been removed since the fixture was
+originally generated.
.INDENT 0.0
.TP
-.B \-\-app
+.B \-\-app APP_LABEL
.UNINDENT
.sp
-The \fI\%\-\-app\fP option can be used to specify a single app to look
-for fixtures in rather than looking through all apps.
+Specifies a single app to look for fixtures in rather than looking in all apps.
+.INDENT 0.0
+.TP
+.B \-\-exclude EXCLUDE, \-e EXCLUDE
+.UNINDENT
.sp
-\fB\-\-ignorenonexistent\fP also ignores non\-existent models.
+.sp
+Excludes loading the fixtures from the given applications and/or models (in the
+form of \fBapp_label\fP or \fBapp_label.ModelName\fP). Use the option multiple
+times to exclude more than one app or model.
.SS What\(aqs a "fixture"?
.sp
A \fIfixture\fP is a collection of files that contain the serialized contents of
@@ -689,7 +744,7 @@ For example, if your \fBDATABASES\fP setting has a \(aqmaster\(aq database
defined, name the fixture \fBmydata.master.json\fP or
\fBmydata.master.json.gz\fP and the fixture will only be loaded when you
specify you want to load data into the \fBmaster\fP database.
-.SS makemessages
+.SS \fBmakemessages\fP
.INDENT 0.0
.TP
.B django\-admin makemessages
@@ -701,32 +756,24 @@ conf/locale (in the Django tree) or locale (for project and application)
directory. After making changes to the messages files you need to compile them
with \fI\%compilemessages\fP for use with the builtin gettext support. See
the i18n documentation for details.
+.sp
+This command doesn\(aqt require configured settings. However, when settings aren\(aqt
+configured, the command can\(aqt ignore the \fBMEDIA_ROOT\fP and
+\fBSTATIC_ROOT\fP directories or include \fBLOCALE_PATHS\fP\&. It will
+also write files in UTF\-8 rather than in \fBFILE_CHARSET\fP\&.
.INDENT 0.0
.TP
-.B \-\-all
+.B \-\-all, \-a
.UNINDENT
.sp
-Use the \fB\-\-all\fP or \fB\-a\fP option to update the message files for all
-available languages.
-.sp
-Example usage:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin makemessages \-\-all
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
+Updates the message files for all available languages.
.INDENT 0.0
.TP
-.B \-\-extension
+.B \-\-extension EXTENSIONS, \-e EXTENSIONS
.UNINDENT
.sp
-Use the \fB\-\-extension\fP or \fB\-e\fP option to specify a list of file extensions
-to examine (default: ".html", ".txt").
+Specifies a list of file extensions to examine (default: \fBhtml\fP, \fBtxt\fP,
+\fBpy\fP or \fBjs\fP if \fI\%\-\-domain\fP is \fBjs\fP).
.sp
Example usage:
.INDENT 0.0
@@ -740,7 +787,8 @@ django\-admin makemessages \-\-locale=de \-\-extension xhtml
.UNINDENT
.UNINDENT
.sp
-Separate multiple extensions with commas or use \-e or \-\-extension multiple times:
+Separate multiple extensions with commas or use \fB\-e\fP or \fB\-\-extension\fP
+multiple times:
.INDENT 0.0
.INDENT 3.5
.sp
@@ -751,14 +799,18 @@ django\-admin makemessages \-\-locale=de \-\-extension=html,txt \-\-extension xm
.fi
.UNINDENT
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-locale LOCALE, \-l LOCALE
+.UNINDENT
.sp
-Use the \fI\%\-\-locale\fP option (or its shorter version \fB\-l\fP) to
-specify the locale(s) to process.
-.sp
-
+Specifies the locale(s) to process.
+.INDENT 0.0
+.TP
+.B \-\-exclude EXCLUDE, \-x EXCLUDE
+.UNINDENT
.sp
-Use the \fI\%\-\-exclude\fP option (or its shorter version \fB\-x\fP) to
-specify the locale(s) to exclude from processing. If not provided, no locales
+Specifies the locale(s) to exclude from processing. If not provided, no locales
are excluded.
.sp
Example usage:
@@ -781,11 +833,10 @@ django\-admin makemessages \-x pt_BR \-x fr
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-domain
+.B \-\-domain DOMAIN, \-d DOMAIN
.UNINDENT
.sp
-Use the \fB\-\-domain\fP or \fB\-d\fP option to change the domain of the messages files.
-Currently supported:
+Specifies the domain of the messages files. Supported options are:
.INDENT 0.0
.IP \(bu 2
\fBdjango\fP for all \fB*.py\fP, \fB*.html\fP and \fB*.txt\fP files (default)
@@ -794,11 +845,10 @@ Currently supported:
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-symlinks
+.B \-\-symlinks, \-s
.UNINDENT
.sp
-Use the \fB\-\-symlinks\fP or \fB\-s\fP option to follow symlinks to directories when
-looking for new translation strings.
+Follows symlinks to directories when looking for new translation strings.
.sp
Example usage:
.INDENT 0.0
@@ -813,13 +863,13 @@ django\-admin makemessages \-\-locale=de \-\-symlinks
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-ignore
+.B \-\-ignore PATTERN, \-i PATTERN
.UNINDENT
.sp
-Use the \fB\-\-ignore\fP or \fB\-i\fP option to ignore files or directories matching
-the given \fI\%glob\fP\-style pattern. Use multiple times to ignore more.
+Ignores files or directories matching the given \fI\%glob\fP\-style pattern. Use
+multiple times to ignore more.
.sp
-These patterns are used by default: \fB\(aqCVS\(aq\fP, \fB\(aq.*\(aq\fP, \fB\(aq*~\(aq\fP, \fB\(aq*.pyc\(aq\fP
+These patterns are used by default: \fB\(aqCVS\(aq\fP, \fB\(aq.*\(aq\fP, \fB\(aq*~\(aq\fP, \fB\(aq*.pyc\(aq\fP\&.
.sp
Example usage:
.INDENT 0.0
@@ -837,31 +887,29 @@ django\-admin makemessages \-\-locale=en_US \-\-ignore=apps/* \-\-ignore=secret/
.B \-\-no\-default\-ignore
.UNINDENT
.sp
-Use the \fB\-\-no\-default\-ignore\fP option to disable the default values of
-\fI\%\-\-ignore\fP\&.
+Disables the default values of \fB\-\-ignore\fP\&.
.INDENT 0.0
.TP
.B \-\-no\-wrap
.UNINDENT
.sp
-Use the \fB\-\-no\-wrap\fP option to disable breaking long message lines into
-several lines in language files.
+Disables breaking long message lines into several lines in language files.
.INDENT 0.0
.TP
.B \-\-no\-location
.UNINDENT
.sp
-Use the \fB\-\-no\-location\fP option to suppress writing \(aq\fB#: filename:line\fP’
-comment lines in language files. Note that using this option makes it harder
-for technically skilled translators to understand each message\(aqs context.
+Suppresses writing \(aq\fB#: filename:line\fP’ comment lines in language files.
+Using this option makes it harder for technically skilled translators to
+understand each message\(aqs context.
.INDENT 0.0
.TP
.B \-\-keep\-pot
.UNINDENT
.sp
-Use the \fB\-\-keep\-pot\fP option to prevent Django from deleting the temporary
-.pot files it generates before creating the .po file. This is useful for
-debugging errors which may prevent the final language files from being created.
+Prevents deleting the temporary \fB\&.pot\fP files generated before creating the
+\fB\&.po\fP file. This is useful for debugging errors which may prevent the final
+language files from being created.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
@@ -870,77 +918,83 @@ See customizing\-makemessages for instructions on how to customize
the keywords that \fI\%makemessages\fP passes to \fBxgettext\fP\&.
.UNINDENT
.UNINDENT
-.SS makemigrations [<app_label>]
+.SS \fBmakemigrations\fP
.INDENT 0.0
.TP
-.B django\-admin makemigrations
+.B django\-admin makemigrations [app_label [app_label ...]]
.UNINDENT
.sp
Creates new migrations based on the changes detected to your models.
Migrations, their relationship with apps and more are covered in depth in
-\fBthe migrations documentation\fP\&.
+the migrations documentation\&.
.sp
Providing one or more app names as arguments will limit the migrations created
to the app(s) specified and any dependencies needed (the table at the other end
of a \fBForeignKey\fP, for example).
+.INDENT 0.0
+.TP
+.B \-\-noinput, \-\-no\-input
+.UNINDENT
.sp
-
-.sp
-The \fB\-\-noinput\fP option may be provided to suppress all user prompts. If a suppressed
-prompt cannot be resolved automatically, the command will exit with error code 3.
+Suppresses all user prompts. If a suppressed prompt cannot be resolved
+automatically, the command will exit with error code 3.
.INDENT 0.0
.TP
.B \-\-empty
.UNINDENT
.sp
-The \fB\-\-empty\fP option will cause \fBmakemigrations\fP to output an empty
-migration for the specified apps, for manual editing. This option is only
-for advanced users and should not be used unless you are familiar with
-the migration format, migration operations, and the dependencies between
-your migrations.
+Outputs an empty migration for the specified apps, for manual editing. This is
+for advanced users and should not be used unless you are familiar with the
+migration format, migration operations, and the dependencies between your
+migrations.
.INDENT 0.0
.TP
.B \-\-dry\-run
.UNINDENT
.sp
-The \fB\-\-dry\-run\fP option shows what migrations would be made without
-actually writing any migrations files to disk. Using this option along with
-\fB\-\-verbosity 3\fP will also show the complete migrations files that would be
-written.
+Shows what migrations would be made without actually writing any migrations
+files to disk. Using this option along with \fB\-\-verbosity 3\fP will also show
+the complete migrations files that would be written.
.INDENT 0.0
.TP
.B \-\-merge
.UNINDENT
.sp
-The \fB\-\-merge\fP option enables fixing of migration conflicts.
+Enables fixing of migration conflicts.
+.INDENT 0.0
+.TP
+.B \-\-name NAME, \-n NAME
+.UNINDENT
+.sp
+Allows naming the generated migration(s) instead of using a generated name.
.INDENT 0.0
.TP
-.B \-\-name, \-n
+.B \-\-exit, \-e
.UNINDENT
.sp
+Deprecated since version 1.10: Use the \fB\-\-check\fP option instead.
.sp
-The \fB\-\-name\fP option allows you to give the migration(s) a custom name instead
-of a generated one.
+Makes \fBmakemigrations\fP exit with error code 1 when no migrations are created
+(or would have been created, if combined with \fB\-\-dry\-run\fP).
.INDENT 0.0
.TP
-.B \-\-exit, \-e
+.B \-\-check
.UNINDENT
.sp
.sp
-The \fB\-\-exit\fP option will cause \fBmakemigrations\fP to exit with error code 1
-when no migrations are created (or would have been created, if combined with
-\fB\-\-dry\-run\fP).
-.SS migrate [<app_label> [<migrationname>]]
+Makes \fBmakemigrations\fP exit with a non\-zero status when model changes without
+migrations are detected.
+.SS \fBmigrate\fP
.INDENT 0.0
.TP
-.B django\-admin migrate
+.B django\-admin migrate [app_label] [migration_name]
.UNINDENT
.sp
Synchronizes the database state with the current set of models and migrations.
Migrations, their relationship with apps and more are covered in depth in
-\fBthe migrations documentation\fP\&.
+the migrations documentation\&.
.sp
The behavior of this command changes depending on the arguments provided:
.INDENT 0.0
@@ -957,17 +1011,19 @@ applied. This may involve unapplying migrations if you have previously
migrated past the named migration. Use the name \fBzero\fP to unapply all
migrations for an app.
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option can be used to specify the database to
-migrate.
+Specifies the database to migrate. Defaults to \fBdefault\fP\&.
.INDENT 0.0
.TP
.B \-\-fake
.UNINDENT
.sp
-The \fB\-\-fake\fP option tells Django to mark the migrations as having been
-applied or unapplied, but without actually running the SQL to change your
-database schema.
+Tells Django to mark the migrations as having been applied or unapplied, but
+without actually running the SQL to change your database schema.
.sp
This is intended for advanced users to manipulate the
current migration state directly if they\(aqre manually applying changes;
@@ -979,11 +1035,9 @@ run correctly.
.B \-\-fake\-initial
.UNINDENT
.sp
-
-.sp
-The \fB\-\-fake\-initial\fP option can be used to allow Django to skip an app\(aqs
-initial migration if all database tables with the names of all models created
-by all \fBCreateModel\fP operations in that
+Allows Django to skip an app\(aqs initial migration if all database tables with
+the names of all models created by all
+\fBCreateModel\fP operations in that
migration already exist. This option is intended for use when first running
migrations against a database that preexisted the use of migrations. This
option does not, however, check for matching database schema beyond matching
@@ -994,19 +1048,20 @@ schema matches what is recorded in your initial migration.
.B \-\-run\-syncdb
.UNINDENT
.sp
-
-.sp
-The \fB\-\-run\-syncdb\fP option allows creating tables for apps without migrations.
-While this isn\(aqt recommended, the migrations framework is sometimes too slow
-on large projects with hundreds of models.
+Allows creating tables for apps without migrations. While this isn\(aqt
+recommended, the migrations framework is sometimes too slow on large projects
+with hundreds of models.
+.INDENT 0.0
+.TP
+.B \-\-noinput, \-\-no\-input
+.UNINDENT
.sp
-Deprecated since version 1.8: The \fB\-\-list\fP option has been moved to the \fI\%showmigrations\fP
-command.
-
-.SS runserver [port or address:port]
+Suppresses all user prompts. An example prompt is asking about removing stale
+content types.
+.SS \fBrunserver\fP
.INDENT 0.0
.TP
-.B django\-admin runserver
+.B django\-admin runserver [addrport]
.UNINDENT
.sp
Starts a lightweight development Web server on the local machine. By default,
@@ -1055,60 +1110,41 @@ You can provide an IPv6 address surrounded by brackets
.sp
A hostname containing ASCII\-only characters can also be used.
.sp
-If the \fBstaticfiles\fP contrib app is enabled
+If the staticfiles contrib app is enabled
(default in new projects) the \fI\%runserver\fP command will be overridden
with its own runserver command.
.sp
If \fI\%migrate\fP was not previously executed, the table that stores the
history of migrations is created at first run of \fBrunserver\fP\&.
+.sp
+Logging of each request and response of the server is sent to the
+django\-server\-logger logger.
+.sp
+In older versions, log messages were written to \fBsys.stderr\fP instead of
+being handled through Python logging.
+
.INDENT 0.0
.TP
.B \-\-noreload
.UNINDENT
.sp
-Use the \fB\-\-noreload\fP option to disable the use of the auto\-reloader. This
-means any Python code changes you make while the server is running will \fInot\fP
-take effect if the particular Python modules have already been loaded into
-memory.
-.sp
-Example usage:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin runserver \-\-noreload
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
+Disables the auto\-reloader. This means any Python code changes you make while
+the server is running will \fInot\fP take effect if the particular Python modules
+have already been loaded into memory.
.INDENT 0.0
.TP
.B \-\-nothreading
.UNINDENT
.sp
-The development server is multithreaded by default. Use the \fB\-\-nothreading\fP
-option to disable the use of threading in the development server.
+Disables use of threading in the development server. The server is
+multithreaded by default.
.INDENT 0.0
.TP
.B \-\-ipv6, \-6
.UNINDENT
.sp
-Use the \fB\-\-ipv6\fP (or shorter \fB\-6\fP) option to tell Django to use IPv6 for
-the development server. This changes the default IP address from
+Uses IPv6 for the development server. This changes the default IP address from
\fB127.0.0.1\fP to \fB::1\fP\&.
-.sp
-Example usage:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin runserver \-\-ipv6
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
.SS Examples of using different ports and addresses
.sp
Port 8000 on IP address \fB127.0.0.1\fP:
@@ -1223,15 +1259,13 @@ django\-admin runserver \-6 localhost:8000
By default, the development server doesn\(aqt serve any static files for your site
(such as CSS files, images, things under \fBMEDIA_URL\fP and so forth). If
you want to configure Django to serve static media, read
-\fB/howto/static\-files/index\fP\&.
-.SS sendtestemail
+/howto/static\-files/index\&.
+.SS \fBsendtestemail\fP
.INDENT 0.0
.TP
-.B django\-admin sendtestemail
+.B django\-admin sendtestemail [email [email ...]]
.UNINDENT
.sp
-
-.sp
Sends a test email (to confirm email sending through Django is working) to the
recipient(s) specified. For example:
.INDENT 0.0
@@ -1244,120 +1278,166 @@ django\-admin sendtestemail foo@example.com bar@example.com
.fi
.UNINDENT
.UNINDENT
+.sp
+There are a couple of options, and you may use any combination of them
+together:
.INDENT 0.0
.TP
.B \-\-managers
.UNINDENT
.sp
-Use the \fB\-\-managers\fP option to mail the email addresses specified in
-\fBMANAGERS\fP using \fBmail_managers()\fP\&.
+Mails the email addresses specified in \fBMANAGERS\fP using
+\fBmail_managers()\fP\&.
.INDENT 0.0
.TP
.B \-\-admins
.UNINDENT
.sp
-Use the \fB\-\-admins\fP option to mail the email addresses specified in
-\fBADMINS\fP using \fBmail_admins()\fP\&.
-.sp
-Note that you may use any combination of these options together.
-.SS shell
+Mails the email addresses specified in \fBADMINS\fP using
+\fBmail_admins()\fP\&.
+.SS \fBshell\fP
.INDENT 0.0
.TP
.B django\-admin shell
.UNINDENT
.sp
Starts the Python interactive interpreter.
+.INDENT 0.0
+.TP
+.B \-\-interface {ipython,bpython,python}, \-i {ipython,bpython,python}
+.UNINDENT
+.sp
+Specifies the shell to use. By default, Django will use \fI\%IPython\fP or \fI\%bpython\fP if
+either is installed. If both are installed, specify which one you want like so:
.sp
-Django will use \fI\%IPython\fP or \fI\%bpython\fP if either is installed. If you have a
-rich shell installed but want to force use of the "plain" Python interpreter,
-use the \fB\-\-plain\fP option, like so:
+IPython:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-django\-admin shell \-\-plain
+django\-admin shell \-i ipython
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
-If you would like to specify either IPython or bpython as your interpreter if
-you have both installed you can specify an alternative interpreter interface
-with the \fB\-i\fP or \fB\-\-interface\fP options like so:
-.sp
-IPython:
+bpython:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-django\-admin shell \-i ipython
-django\-admin shell \-\-interface ipython
+django\-admin shell \-i bpython
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
-bpython:
+If you have a "rich" shell installed but want to force use of the "plain"
+Python interpreter, use \fBpython\fP as the interface name, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-django\-admin shell \-i bpython
-django\-admin shell \-\-interface bpython
+django\-admin shell \-i python
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
-When the "plain" Python interactive interpreter starts (be it because
-\fB\-\-plain\fP was specified or because no other interactive interface is
-available) it reads the script pointed to by the \fI\%PYTHONSTARTUP\fP
-environment variable and the \fB~/.pythonrc.py\fP script. If you don\(aqt wish this
-behavior you can use the \fB\-\-no\-startup\fP option. e.g.:
+Deprecated since version 1.10: In older versions, use the \fB\-\-plain\fP option instead of \fB\-i python\fP\&. This
+is deprecated and will be removed in Django 2.0.
+
+.INDENT 0.0
+.TP
+.B \-\-nostartup
+.UNINDENT
+.sp
+Disables reading the startup script for the "plain" Python interpreter. By
+default, the script pointed to by the \fI\%PYTHONSTARTUP\fP environment
+variable or the \fB~/.pythonrc.py\fP script is read.
+.INDENT 0.0
+.TP
+.B \-\-command COMMAND, \-c COMMAND
+.UNINDENT
+.sp
+
+.sp
+Lets you pass a command as a string to execute it as Django, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-django\-admin shell \-\-plain \-\-no\-startup
+django\-admin shell \-\-command="import django; print(django.__version__)"
.ft P
.fi
.UNINDENT
.UNINDENT
-.SS showmigrations [<app_label> [<app_label>]]
+.sp
+You can also pass code in on standard input to execute it. For example:
.INDENT 0.0
-.TP
-.B django\-admin showmigrations
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ django\-admin shell <<EOF
+> import django
+> print(django.__version__)
+> EOF
+.ft P
+.fi
.UNINDENT
+.UNINDENT
+.sp
+On Windows, the REPL is output due to implementation limits of
+\fI\%select.select()\fP on that platform.
.sp
+In older versions, the REPL is also output on UNIX systems.
+.SS \fBshowmigrations\fP
+.INDENT 0.0
+.TP
+.B django\-admin showmigrations [app_label [app_label ...]]
+.UNINDENT
.sp
-Shows all migrations in a project.
+Shows all migrations in a project. You can choose from one of two formats:
.INDENT 0.0
.TP
.B \-\-list, \-l
.UNINDENT
.sp
-The \fB\-\-list\fP option lists all of the apps Django knows about, the
-migrations available for each app, and whether or not each migration is
-applied (marked by an \fB[X]\fP next to the migration name).
+Lists all of the apps Django knows about, the migrations available for each
+app, and whether or not each migration is applied (marked by an \fB[X]\fP next to
+the migration name).
.sp
Apps without migrations are also listed, but have \fB(no migrations)\fP printed
under them.
+.sp
+This is the default output format.
.INDENT 0.0
.TP
.B \-\-plan, \-p
.UNINDENT
.sp
-The \fB\-\-plan\fP option shows the migration plan Django will follow to apply
-migrations. Any supplied app labels are ignored because the plan might go
-beyond those apps. Same as \fB\-\-list\fP, applied migrations are marked by an
-\fB[X]\fP\&. For a verbosity of 2 and above, all dependencies of a migration will
-also be shown.
-.SS sqlflush
+Shows the migration plan Django will follow to apply migrations. Like
+\fB\-\-list\fP, applied migrations are marked by an \fB[X]\fP\&. For a \fB\-\-verbosity\fP
+of 2 and above, all dependencies of a migration will also be shown.
+.sp
+\fBapp_label\fPs arguments limit the output, however, dependencies of provided
+apps may also be included.
+.sp
+In older versions, \fBshowmigrations \-\-plan\fP ignores app labels.
+
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
+.sp
+Specifies the database to examine. Defaults to \fBdefault\fP\&.
+.SS \fBsqlflush\fP
.INDENT 0.0
.TP
.B django\-admin sqlflush
@@ -1365,13 +1445,16 @@ also be shown.
.sp
Prints the SQL statements that would be executed for the \fI\%flush\fP
command.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option can be used to specify the database for
-which to print the SQL.
-.SS sqlmigrate <app_label> <migrationname>
+Specifies the database for which to print the SQL. Defaults to \fBdefault\fP\&.
+.SS \fBsqlmigrate\fP
.INDENT 0.0
.TP
-.B django\-admin sqlmigrate
+.B django\-admin sqlmigrate app_label migration_name
.UNINDENT
.sp
Prints the SQL for the named migration. This requires an active database
@@ -1379,26 +1462,23 @@ connection, which it will use to resolve constraint names; this means you must
generate the SQL against a copy of the database you wish to later apply it on.
.sp
Note that \fBsqlmigrate\fP doesn\(aqt colorize its output.
-.sp
-The \fI\%\-\-database\fP option can be used to specify the database for
-which to generate the SQL.
.INDENT 0.0
.TP
.B \-\-backwards
.UNINDENT
.sp
-By default, the SQL created is for running the migration in the forwards
-direction. Pass \fB\-\-backwards\fP to generate the SQL for
-unapplying the migration instead.
+Generates the SQL for unapplying the migration. By default, the SQL created is
+for running the migration in the forwards direction.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-To increase the readability of the overall SQL output the SQL code
-generated for each migration operation is preceded by the operation\(aqs
-description.
-
-.SS sqlsequencereset <app_label app_label ...>
+Specifies the database for which to generate the SQL. Defaults to \fBdefault\fP\&.
+.SS \fBsqlsequencereset\fP
.INDENT 0.0
.TP
-.B django\-admin sqlsequencereset
+.B django\-admin sqlsequencereset app_label [app_label ...]
.UNINDENT
.sp
Prints the SQL statements for resetting sequences for the given app name(s).
@@ -1408,13 +1488,16 @@ number for automatically incremented fields.
.sp
Use this command to generate SQL which will fix cases where a sequence is out
of sync with its automatically incremented field data.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-The \fI\%\-\-database\fP option can be used to specify the database for
-which to print the SQL.
-.SS squashmigrations <app_label> [<start_migration_name>] <migration_name>
+Specifies the database for which to print the SQL. Defaults to \fBdefault\fP\&.
+.SS \fBsquashmigrations\fP
.INDENT 0.0
.TP
-.B django\-admin squashmigrations
+.B django\-admin squashmigrations app_label [start_migration_name] migration_name
.UNINDENT
.sp
Squashes the migrations for \fBapp_label\fP up to and including \fBmigration_name\fP
@@ -1422,8 +1505,6 @@ down into fewer migrations, if possible. The resulting squashed migrations
can live alongside the unsquashed ones safely. For more information,
please read migration\-squashing\&.
.sp
-
-.sp
When \fBstart_migration_name\fP is given, Django will only include migrations
starting from and including this migration. This helps to mitigate the
squashing limitation of \fBRunPython\fP and
@@ -1433,15 +1514,21 @@ squashing limitation of \fBRunPython\fP and
.B \-\-no\-optimize
.UNINDENT
.sp
-By default, Django will try to optimize the operations in your migrations
-to reduce the size of the resulting file. Pass \fB\-\-no\-optimize\fP if this
-process is failing for you or creating incorrect migrations, though please
-also file a Django bug report about the behavior, as optimization is meant
-to be safe.
-.SS startapp <app_label> [destination]
+Disables the optimizer when generating a squashed migration. By default, Django
+will try to optimize the operations in your migrations to reduce the size of
+the resulting file. Use this option if this process is failing or creating
+incorrect migrations, though please also file a Django bug report about the
+behavior, as optimization is meant to be safe.
.INDENT 0.0
.TP
-.B django\-admin startapp
+.B \-\-noinput, \-\-no\-input
+.UNINDENT
+.sp
+Suppresses all user prompts.
+.SS \fBstartapp\fP
+.INDENT 0.0
+.TP
+.B django\-admin startapp name [directory]
.UNINDENT
.sp
Creates a Django app directory structure for the given app name in the current
@@ -1469,11 +1556,10 @@ django\-admin startapp myapp /Users/jezdez/Code/myapp
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-template
+.B \-\-template TEMPLATE
.UNINDENT
.sp
-With the \fB\-\-template\fP option, you can use a custom app template by providing
-either the path to a directory with the app template file, or a path to a
+Provides the path to a directory with a custom app template file or a path to a
compressed file (\fB\&.tar.gz\fP, \fB\&.tar.bz2\fP, \fB\&.tgz\fP, \fB\&.tbz\fP, \fB\&.zip\fP)
containing the app template files.
.sp
@@ -1506,11 +1592,24 @@ django\-admin startapp \-\-template=https://github.com/githubuser/django\-app\-t
.fi
.UNINDENT
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-extension EXTENSIONS, \-e EXTENSIONS
+.UNINDENT
+.sp
+Specifies which file extensions in the app template should be rendered with the
+template engine. Defaults to \fBpy\fP\&.
+.INDENT 0.0
+.TP
+.B \-\-name FILES, \-n FILES
+.UNINDENT
.sp
-When Django copies the app template files, it also renders certain files
-through the template engine: the files whose extensions match the
-\fB\-\-extension\fP option (\fBpy\fP by default) and the files whose names are passed
-with the \fB\-\-name\fP option. The \fBtemplate context\fP used is:
+Specifies which files in the app template (in addition to those matching
+\fB\-\-extension\fP) should be rendered with the template engine. Defaults to an
+empty list.
+.sp
+The \fBtemplate context\fP used for all matching
+files is:
.INDENT 0.0
.IP \(bu 2
Any option passed to the \fBstartapp\fP command (among the command\(aqs supported
@@ -1525,9 +1624,6 @@ options)
\fBdocs_version\fP \-\- the version of the documentation: \fB\(aqdev\(aq\fP or \fB\(aq1.x\(aq\fP
.UNINDENT
.sp
-\fBcamel_case_app_name\fP was added.
-
-.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
@@ -1539,12 +1635,17 @@ to template rendering, it might result in an incorrect example.
.sp
To work around this problem, you can use the \fBtemplatetag\fP
templatetag to "escape" the various parts of the template syntax.
+.sp
+In addition, to allow Python template files that contain Django template
+language syntax while also preventing packaging systems from trying to
+byte\-compile invalid \fB*.py\fP files, template files ending with \fB\&.py\-tpl\fP
+will be renamed to \fB\&.py\fP\&.
.UNINDENT
.UNINDENT
-.SS startproject <projectname> [destination]
+.SS \fBstartproject\fP
.INDENT 0.0
.TP
-.B django\-admin startproject
+.B django\-admin startproject name [directory]
.UNINDENT
.sp
Creates a Django project directory structure for the given project name in
@@ -1573,46 +1674,30 @@ django\-admin startproject myproject /Users/jezdez/Code/myproject_repo
.fi
.UNINDENT
.UNINDENT
-.sp
-As with the \fI\%startapp\fP command, the \fB\-\-template\fP option lets you
-specify a directory, file path or URL of a custom project template. See the
-\fI\%startapp\fP documentation for details of supported project template
-formats.
-.sp
-For example, this would look for a project template in the given directory
-when creating the \fBmyproject\fP project:
.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin startproject \-\-template=/Users/jezdez/Code/my_project_template myproject
-.ft P
-.fi
-.UNINDENT
+.TP
+.B \-\-template TEMPLATE
.UNINDENT
.sp
-Django will also accept URLs (\fBhttp\fP, \fBhttps\fP, \fBftp\fP) to compressed
-archives with the project template files, downloading and extracting them on the
-fly.
-.sp
-For example, taking advantage of GitHub\(aqs feature to expose repositories as
-zip files, you can use a URL like:
+Specifies a directory, file path, or URL of a custom project template. See the
+\fI\%startapp \-\-template\fP documentation for examples and usage.
.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin startproject \-\-template=https://github.com/githubuser/django\-project\-template/archive/master.zip myproject
-.ft P
-.fi
+.TP
+.B \-\-extension EXTENSIONS, \-e EXTENSIONS
.UNINDENT
+.sp
+Specifies which file extensions in the project template should be rendered with
+the template engine. Defaults to \fBpy\fP\&.
+.INDENT 0.0
+.TP
+.B \-\-name FILES, \-n FILES
.UNINDENT
.sp
-When Django copies the project template files, it also renders certain files
-through the template engine: the files whose extensions match the
-\fB\-\-extension\fP option (\fBpy\fP by default) and the files whose names are passed
-with the \fB\-\-name\fP option. The \fBtemplate context\fP used is:
+Specifies which files in the project template (in addition to those matching
+\fB\-\-extension\fP) should be rendered with the template engine. Defaults to an
+empty list.
+.sp
+The \fBtemplate context\fP used is:
.INDENT 0.0
.IP \(bu 2
Any option passed to the \fBstartproject\fP command (among the command\(aqs
@@ -1629,83 +1714,81 @@ supported options)
.sp
Please also see the \fI\%rendering warning\fP as mentioned
for \fI\%startapp\fP\&.
-.SS test <app or test identifier>
+.SS \fBtest\fP
.INDENT 0.0
.TP
-.B django\-admin test
+.B django\-admin test [test_label [test_label ...]]
.UNINDENT
.sp
-Runs tests for all installed models. See \fB/topics/testing/index\fP for more
+Runs tests for all installed apps. See /topics/testing/index for more
information.
.INDENT 0.0
.TP
.B \-\-failfast
.UNINDENT
.sp
-The \fB\-\-failfast\fP option can be used to stop running tests and report the
-failure immediately after a test fails.
+Stops running tests and reports the failure immediately after a test fails.
.INDENT 0.0
.TP
-.B \-\-testrunner
+.B \-\-testrunner TESTRUNNER
.UNINDENT
.sp
-The \fB\-\-testrunner\fP option can be used to control the test runner class that
-is used to execute tests. If this value is provided, it overrides the value
-provided by the \fBTEST_RUNNER\fP setting.
+Controls the test runner class that is used to execute tests. This value
+overrides the value provided by the \fBTEST_RUNNER\fP setting.
.INDENT 0.0
.TP
-.B \-\-liveserver
+.B \-\-noinput, \-\-no\-input
.UNINDENT
.sp
-The \fB\-\-liveserver\fP option can be used to override the default address where
-the live server (used with \fBLiveServerTestCase\fP) is
-expected to run from. The default value is \fBlocalhost:8081\-8179\fP\&.
+Suppresses all user prompts. A typical prompt is a warning about deleting an
+existing test database.
+.SS Test runner options
.sp
-In earlier versions, the default value was \fBlocalhost:8081\fP\&.
-
+The \fBtest\fP command receives options on behalf of the specified
+\fI\%\-\-testrunner\fP\&. These are the options of the default test runner:
+\fBDiscoverRunner\fP\&.
.INDENT 0.0
.TP
-.B \-\-keepdb
+.B \-\-keepdb, \-k
.UNINDENT
.sp
-
-.sp
-The \fB\-\-keepdb\fP option can be used to preserve the test database between test
-runs. This has the advantage of skipping both the create and destroy actions
-which can greatly decrease the time to run tests, especially those in a large
-test suite. If the test database does not exist, it will be created on the first
-run and then preserved for each subsequent run. Any unapplied migrations will also
-be applied to the test database before running the test suite.
+Preserves the test database between test runs. This has the advantage of
+skipping both the create and destroy actions which can greatly decrease the
+time to run tests, especially those in a large test suite. If the test database
+does not exist, it will be created on the first run and then preserved for each
+subsequent run. Any unapplied migrations will also be applied to the test
+database before running the test suite.
.INDENT 0.0
.TP
-.B \-\-reverse
+.B \-\-reverse, \-r
.UNINDENT
.sp
-
-.sp
-The \fB\-\-reverse\fP option can be used to sort test cases in the opposite order.
-This may help in debugging the side effects of tests that aren\(aqt properly
-isolated. Grouping by test class is preserved when using
-this option.
+Sorts test cases in the opposite execution order. This may help in debugging
+the side effects of tests that aren\(aqt properly isolated. Grouping by test
+class is preserved when using this option.
.INDENT 0.0
.TP
-.B \-\-debug\-sql
+.B \-\-debug\-mode
.UNINDENT
.sp
.sp
-The \fB\-\-debug\-sql\fP option can be used to enable SQL logging for failing tests. If \fI\%\-\-verbosity\fP is \fB2\fP,
-then queries in passing tests are also output.
+Sets the \fBDEBUG\fP setting to \fBTrue\fP prior to running tests. This may
+help troubleshoot test failures.
.INDENT 0.0
.TP
-.B \-\-parallel
+.B \-\-debug\-sql, \-d
.UNINDENT
.sp
-
+Enables SQL logging for failing tests. If
+\fB\-\-verbosity\fP is \fB2\fP, then queries in passing tests are also output.
+.INDENT 0.0
+.TP
+.B \-\-parallel [N]
+.UNINDENT
.sp
-The \fB\-\-parallel\fP option can be used to run tests in parallel in separate
-processes. Since modern processors have multiple cores, this allows running
-tests significantly faster.
+Runs tests in separate parallel processes. Since modern processors have
+multiple cores, this allows running tests significantly faster.
.sp
By default \fB\-\-parallel\fP runs one process per core according to
\fI\%multiprocessing.cpu_count()\fP\&. You can adjust the number of processes
@@ -1736,6 +1819,10 @@ $ pip install tblib
This feature isn\(aqt available on Windows. It doesn\(aqt work with the Oracle
database backend either.
.sp
+If you want to use \fI\%pdb\fP while debugging tests, you must disable parallel
+execution (\fB\-\-parallel=1\fP). You\(aqll see something like \fBbdb.BdbQuit\fP if you
+don\(aqt.
+.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
@@ -1749,10 +1836,28 @@ in order to exchange them between processes. See
\fI\%What can be pickled and unpickled?\fP for details.
.UNINDENT
.UNINDENT
-.SS testserver <fixture fixture ...>
.INDENT 0.0
.TP
-.B django\-admin testserver
+.B \-\-tag TAGS
+.UNINDENT
+.sp
+
+.sp
+Runs only tests marked with the specified tags\&.
+May be specified multiple times and combined with \fI\%test \-\-exclude\-tag\fP\&.
+.INDENT 0.0
+.TP
+.B \-\-exclude\-tag EXCLUDE_TAGS
+.UNINDENT
+.sp
+
+.sp
+Excludes tests marked with the specified tags\&.
+May be specified multiple times and combined with \fI\%test \-\-tag\fP\&.
+.SS \fBtestserver\fP
+.INDENT 0.0
+.TP
+.B django\-admin testserver [fixture [fixture ...]]
.UNINDENT
.sp
Runs a Django development server (as in \fI\%runserver\fP) using data from
@@ -1785,7 +1890,7 @@ this newly created test database instead of your production database.
This is useful in a number of ways:
.INDENT 0.0
.IP \(bu 2
-When you\(aqre writing \fBunit tests\fP of how your views
+When you\(aqre writing unit tests of how your views
act with certain fixture data, you can use \fBtestserver\fP to interact with
the views in a Web browser, manually.
.IP \(bu 2
@@ -1803,13 +1908,12 @@ source code (as \fI\%runserver\fP does). It does, however, detect changes to
templates.
.INDENT 0.0
.TP
-.B \-\-addrport [port number or ipaddr:port]
+.B \-\-addrport ADDRPORT
.UNINDENT
.sp
-Use \fB\-\-addrport\fP to specify a different port, or IP address and port, from
-the default of \fB127.0.0.1:8000\fP\&. This value follows exactly the same format and
-serves exactly the same function as the argument to the \fI\%runserver\fP
-command.
+Specifies a different port, or IP address and port, from the default of
+\fB127.0.0.1:8000\fP\&. This value follows exactly the same format and serves
+exactly the same function as the argument to the \fI\%runserver\fP command.
.sp
Examples:
.sp
@@ -1841,31 +1945,38 @@ django\-admin testserver \-\-addrport 1.2.3.4:7000 test
.fi
.UNINDENT
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-noinput, \-\-no\-input
+.UNINDENT
.sp
-The \fI\%\-\-noinput\fP option may be provided to suppress all user
-prompts.
+Suppresses all user prompts. A typical prompt is a warning about deleting an
+existing test database.
.SH COMMANDS PROVIDED BY APPLICATIONS
.sp
Some commands are only available when the \fBdjango.contrib\fP application that
-\fBimplements\fP them has been
+implements them has been
\fBenabled\fP\&. This section describes them grouped by
their application.
.SS \fBdjango.contrib.auth\fP
-.SS changepassword
+.SS \fBchangepassword\fP
.INDENT 0.0
.TP
-.B django\-admin changepassword
+.B django\-admin changepassword [<username>]
.UNINDENT
.sp
-This command is only available if Django\(aqs \fBauthentication system\fP (\fBdjango.contrib.auth\fP) is installed.
+This command is only available if Django\(aqs authentication system (\fBdjango.contrib.auth\fP) is installed.
.sp
Allows changing a user\(aqs password. It prompts you to enter a new password twice
for the given user. If the entries are identical, this immediately becomes the
new password. If you do not supply a user, the command will attempt to change
the password whose username matches the current user.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-Use the \fB\-\-database\fP option to specify the database to query for the user. If
-it\(aqs not supplied, Django will use the \fBdefault\fP database.
+Specifies the database to query for the user. Defaults to \fBdefault\fP\&.
.sp
Example usage:
.INDENT 0.0
@@ -1878,13 +1989,13 @@ django\-admin changepassword ringo
.fi
.UNINDENT
.UNINDENT
-.SS createsuperuser
+.SS \fBcreatesuperuser\fP
.INDENT 0.0
.TP
.B django\-admin createsuperuser
.UNINDENT
.sp
-This command is only available if Django\(aqs \fBauthentication system\fP (\fBdjango.contrib.auth\fP) is installed.
+This command is only available if Django\(aqs authentication system (\fBdjango.contrib.auth\fP) is installed.
.sp
Creates a superuser account (a user who has all permissions). This is
useful if you need to create an initial superuser account or if you need to
@@ -1896,22 +2007,23 @@ will be set, and the superuser account will not be able to log in until
a password has been manually set for it.
.INDENT 0.0
.TP
-.B \-\-username
+.B \-\-username USERNAME
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-email
+.B \-\-email EMAIL
.UNINDENT
.sp
The username and email address for the new account can be supplied by
using the \fB\-\-username\fP and \fB\-\-email\fP arguments on the command
line. If either of those is not supplied, \fBcreatesuperuser\fP will prompt for
it when running interactively.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
.sp
-Use the \fB\-\-database\fP option to specify the database into which the superuser
-object will be saved.
-.sp
-
+Specifies the database into which the superuser object will be saved.
.sp
You can subclass the management command and override \fBget_input_data()\fP if you
want to customize data input and validation. Consult the source code for
@@ -1920,16 +2032,37 @@ it could be useful if you have a \fBForeignKey\fP in
\fBREQUIRED_FIELDS\fP and want to
allow creating an instance instead of entering the primary key of an existing
instance.
+.SS \fBdjango.contrib.contenttypes\fP
+.SS \fBremove_stale_contenttypes\fP
+.INDENT 0.0
+.TP
+.B django\-admin remove_stale_contenttypes
+.UNINDENT
+.sp
+
+.sp
+This command is only available if Django\(aqs contenttypes app (\fBdjango.contrib.contenttypes\fP) is installed.
+.sp
+Deletes stale content types (from deleted models) in your database. Any objects
+that depend on the deleted content types will also be deleted. A list of
+deleted objects will be displayed before you confirm it\(aqs okay to proceed with
+the deletion.
+.INDENT 0.0
+.TP
+.B \-\-database DATABASE
+.UNINDENT
+.sp
+Specifies the database to use. Defaults to \fBdefault\fP\&.
.SS \fBdjango.contrib.gis\fP
-.SS ogrinspect
+.SS \fBogrinspect\fP
.sp
-This command is only available if \fBGeoDjango\fP
+This command is only available if GeoDjango
(\fBdjango.contrib.gis\fP) is installed.
.sp
Please refer to its \fBdescription\fP in the GeoDjango
documentation.
.SS \fBdjango.contrib.sessions\fP
-.SS clearsessions
+.SS \fBclearsessions\fP
.INDENT 0.0
.TP
.B django\-admin clearsessions
@@ -1937,33 +2070,40 @@ documentation.
.sp
Can be run as a cron job or directly to clean out expired sessions.
.SS \fBdjango.contrib.sitemaps\fP
-.SS ping_google
+.SS \fBping_google\fP
.sp
-This command is only available if the \fBSitemaps framework\fP (\fBdjango.contrib.sitemaps\fP) is installed.
+This command is only available if the Sitemaps framework (\fBdjango.contrib.sitemaps\fP) is installed.
.sp
Please refer to its \fBdescription\fP in the Sitemaps
documentation.
.SS \fBdjango.contrib.staticfiles\fP
-.SS collectstatic
+.SS \fBcollectstatic\fP
.sp
-This command is only available if the \fBstatic files application\fP (\fBdjango.contrib.staticfiles\fP) is installed.
+This command is only available if the static files application (\fBdjango.contrib.staticfiles\fP) is installed.
.sp
Please refer to its \fBdescription\fP in the
-\fBstaticfiles\fP documentation.
-.SS findstatic
+staticfiles documentation.
+.SS \fBfindstatic\fP
.sp
-This command is only available if the \fBstatic files application\fP (\fBdjango.contrib.staticfiles\fP) is installed.
+This command is only available if the static files application (\fBdjango.contrib.staticfiles\fP) is installed.
.sp
-Please refer to its \fBdescription\fP in the \fBstaticfiles\fP documentation.
+Please refer to its \fBdescription\fP in the staticfiles documentation.
.SH DEFAULT OPTIONS
.sp
Although some commands may allow their own custom options, every command
allows for the following options:
.INDENT 0.0
.TP
-.B \-\-pythonpath
+.B \-\-pythonpath PYTHONPATH
.UNINDENT
.sp
+Adds the given filesystem path to the Python \fI\%import search path\fP\&. If this
+isn\(aqt provided, \fBdjango\-admin\fP will use the \fBPYTHONPATH\fP environment
+variable.
+.sp
+This option is unnecessary in \fBmanage.py\fP, because it takes care of setting
+the Python path for you.
+.sp
Example usage:
.INDENT 0.0
.INDENT 3.5
@@ -1975,18 +2115,18 @@ django\-admin migrate \-\-pythonpath=\(aq/home/djangoprojects/myproject\(aq
.fi
.UNINDENT
.UNINDENT
-.sp
-Adds the given filesystem path to the Python \fI\%import search path\fP\&. If this
-isn\(aqt provided, \fBdjango\-admin\fP will use the \fBPYTHONPATH\fP environment
-variable.
-.sp
-Note that this option is unnecessary in \fBmanage.py\fP, because it takes care of
-setting the Python path for you.
.INDENT 0.0
.TP
-.B \-\-settings
+.B \-\-settings SETTINGS
.UNINDENT
.sp
+Specifies the settings module to use. The settings module should be in Python
+package syntax, e.g. \fBmysite.settings\fP\&. If this isn\(aqt provided,
+\fBdjango\-admin\fP will use the \fBDJANGO_SETTINGS_MODULE\fP environment variable.
+.sp
+This option is unnecessary in \fBmanage.py\fP, because it uses
+\fBsettings.py\fP from the current project by default.
+.sp
Example usage:
.INDENT 0.0
.INDENT 3.5
@@ -1998,19 +2138,15 @@ django\-admin migrate \-\-settings=mysite.settings
.fi
.UNINDENT
.UNINDENT
-.sp
-Explicitly specifies the settings module to use. The settings module should be
-in Python package syntax, e.g. \fBmysite.settings\fP\&. If this isn\(aqt provided,
-\fBdjango\-admin\fP will use the \fBDJANGO_SETTINGS_MODULE\fP environment
-variable.
-.sp
-Note that this option is unnecessary in \fBmanage.py\fP, because it uses
-\fBsettings.py\fP from the current project by default.
.INDENT 0.0
.TP
.B \-\-traceback
.UNINDENT
.sp
+Displays a full stack trace when a \fBCommandError\fP
+is raised. By default, \fBdjango\-admin\fP will show a simple error message when a
+\fBCommandError\fP occurs and a full stack trace for any other exception.
+.sp
Example usage:
.INDENT 0.0
.INDENT 3.5
@@ -2022,30 +2158,13 @@ django\-admin migrate \-\-traceback
.fi
.UNINDENT
.UNINDENT
-.sp
-By default, \fBdjango\-admin\fP will show a simple error message whenever a
-\fBCommandError\fP occurs, but a full stack trace
-for any other exception. If you specify \fB\-\-traceback\fP, \fBdjango\-admin\fP
-will also output a full stack trace when a \fBCommandError\fP is raised.
.INDENT 0.0
.TP
-.B \-\-verbosity
-.UNINDENT
-.sp
-Example usage:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin migrate \-\-verbosity 2
-.ft P
-.fi
-.UNINDENT
+.B \-\-verbosity {0,1,2,3}, \-\-v {0,1,2,3}
.UNINDENT
.sp
-Use \fB\-\-verbosity\fP to specify the amount of notification and debug information
-that \fBdjango\-admin\fP should print to the console.
+Specifies the amount of notification and debug information that a command
+should print to the console.
.INDENT 0.0
.IP \(bu 2
\fB0\fP means no output.
@@ -2056,10 +2175,6 @@ that \fBdjango\-admin\fP should print to the console.
.IP \(bu 2
\fB3\fP means \fIvery\fP verbose output.
.UNINDENT
-.INDENT 0.0
-.TP
-.B \-\-no\-color
-.UNINDENT
.sp
Example usage:
.INDENT 0.0
@@ -2067,89 +2182,31 @@ Example usage:
.sp
.nf
.ft C
-django\-admin runserver \-\-no\-color
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-By default, \fBdjango\-admin\fP will format the output to be colorized. For
-example, errors will be printed to the console in red and SQL statements will
-be syntax highlighted. To prevent this and have a plain text output, pass the
-\fB\-\-no\-color\fP option when running your command.
-.SH COMMON OPTIONS
-.sp
-The following options are not available on every command, but they are common
-to a number of commands.
-.INDENT 0.0
-.TP
-.B \-\-database
-.UNINDENT
-.sp
-Used to specify the database on which a command will operate. If not
-specified, this option will default to an alias of \fBdefault\fP\&.
-.sp
-For example, to dump data from the database with the alias \fBmaster\fP:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin dumpdata \-\-database=master
+django\-admin migrate \-\-verbosity 2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-exclude
+.B \-\-no\-color
.UNINDENT
.sp
-Exclude a specific application from the applications whose contents is
-output. For example, to specifically exclude the \fBauth\fP application from
-the output of dumpdata, you would call:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-django\-admin dumpdata \-\-exclude=auth
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
+Disables colorized command output. Some commands format their output to be
+colorized. For example, errors will be printed to the console in red and SQL
+statements will be syntax highlighted.
.sp
-If you want to exclude multiple applications, use multiple \fB\-\-exclude\fP
-directives:
+Example usage:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
-django\-admin dumpdata \-\-exclude=auth \-\-exclude=contenttypes
+django\-admin runserver \-\-no\-color
.ft P
.fi
.UNINDENT
.UNINDENT
-.INDENT 0.0
-.TP
-.B \-\-locale
-.UNINDENT
-.sp
-Use the \fB\-\-locale\fP or \fB\-l\fP option to specify the locale to process.
-If not provided all locales are processed.
-.INDENT 0.0
-.TP
-.B \-\-noinput
-.UNINDENT
-.sp
-Use the \fB\-\-noinput\fP option to suppress all user prompting, such as "Are
-you sure?" confirmation messages. This is useful if \fBdjango\-admin\fP is
-being executed as an unattended, automated script. You can use \fB\-\-no\-input\fP
-as an alias for this option.
-.sp
-The \fB\-\-no\-input\fP alias was added.
-
.SH EXTRA NICETIES
.SS Syntax coloring
.sp
@@ -2199,6 +2256,10 @@ number of roles in which color is used:
.IP \(bu 2
\fBnotice\fP \- A minor error.
.IP \(bu 2
+\fBsuccess\fP \- A success.
+.IP \(bu 2
+\fBwarning\fP \- A warning.
+.IP \(bu 2
\fBsql_field\fP \- The name of a model field in SQL.
.IP \(bu 2
\fBsql_coltype\fP \- The type of a model field in SQL.
@@ -2220,6 +2281,10 @@ number of roles in which color is used:
\fBhttp_bad_request\fP \- A 4XX HTTP Bad Request server response other than 404.
.IP \(bu 2
\fBhttp_server_error\fP \- A 5XX HTTP Server Error response.
+.IP \(bu 2
+\fBmigrate_heading\fP \- A heading in a migrations management command.
+.IP \(bu 2
+\fBmigrate_label\fP \- A migration name.
.UNINDENT
.sp
Each of these roles can be assigned a specific foreground and
@@ -2322,7 +2387,7 @@ Type \fBsql\fP, then [TAB], to see all available options whose names start
with \fBsql\fP\&.
.UNINDENT
.sp
-See \fB/howto/custom\-management\-commands\fP for how to add customized actions.
+See /howto/custom\-management\-commands for how to add customized actions.
.INDENT 0.0
.TP
.B django.core.management.call_command(name, *args, **options)
@@ -2332,13 +2397,19 @@ To call a management command from code use \fBcall_command\fP\&.
.INDENT 0.0
.TP
.B \fBname\fP
-the name of the command to call.
+the name of the command to call or a command object. Passing the name is
+preferred unless the object is required for testing.
.TP
.B \fB*args\fP
-a list of arguments accepted by the command.
+a list of arguments accepted by the command. Arguments are passed to the
+argument parser, so you can use the same style as you would on the command
+line. For example, \fBcall_command(\(aqflush\(aq, \(aqverbosity=0\(aq)\fP\&.
.TP
.B \fB**options\fP
-named options accepted on the command\-line.
+named options accepted on the command\-line. Options are passed to the command
+without triggering the argument parser, which means you\(aqll need to pass the
+correct type. For example, \fBcall_command(\(aqflush\(aq, verbosity=0)\fP (zero must
+be an integer rather than a string).
.UNINDENT
.sp
Examples:
@@ -2348,8 +2419,11 @@ Examples:
.nf
.ft C
from django.core import management
+from django.core.management.commands import loaddata
+
management.call_command(\(aqflush\(aq, verbosity=0, interactive=False)
management.call_command(\(aqloaddata\(aq, \(aqtest_data\(aq, verbosity=0)
+management.call_command(loaddata.Command(), \(aqtest_data\(aq, verbosity=0)
.ft P
.fi
.UNINDENT
@@ -2378,12 +2452,6 @@ management.call_command(\(aqdumpdata\(aq, use_natural_foreign_keys=True)
.UNINDENT
.UNINDENT
.sp
-The first syntax is now supported thanks to management commands using the
-\fI\%argparse\fP module. For the second syntax, Django previously passed
-the option name as\-is to the command, now it is always using the \fBdest\fP
-variable name (which may or may not be the same as the option name).
-
-.sp
Command options which take multiple options are passed a list:
.INDENT 0.0
.INDENT 3.5
@@ -2395,6 +2463,14 @@ management.call_command(\(aqdumpdata\(aq, exclude=[\(aqcontenttypes\(aq, \(aqaut
.fi
.UNINDENT
.UNINDENT
+.sp
+The return value of the \fBcall_command()\fP function is the same as the return
+value of the \fBhandle()\fP method of the command.
+.sp
+\fBcall_command()\fP now returns the value received from the
+\fBcommand.handle()\fP method. It now also accepts a command object as the
+first argument.
+
.SH OUTPUT REDIRECTION
.sp
Note that you can redirect standard output and error streams as all commands