Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Added a man page for django-admin.py. Also install it correctly as pa…

…rt of the

auto-generated rpm. Thanks to Marc Fargas and Paul Bissex for writing the man
page. Refs #3341.



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

0 notes on commit b912260

Please sign in to comment.
Something went wrong with that request. Please try again.