diff options
Diffstat (limited to 'parts/django/docs/man')
| -rw-r--r-- | parts/django/docs/man/daily_cleanup.1 | 34 | ||||
| -rw-r--r-- | parts/django/docs/man/django-admin.1 | 226 | ||||
| -rw-r--r-- | parts/django/docs/man/gather_profile_stats.1 | 26 |
3 files changed, 0 insertions, 286 deletions
diff --git a/parts/django/docs/man/daily_cleanup.1 b/parts/django/docs/man/daily_cleanup.1 deleted file mode 100644 index dfcde1d..0000000 --- a/parts/django/docs/man/daily_cleanup.1 +++ /dev/null @@ -1,34 +0,0 @@ -.TH "daily_cleanup.py" "1" "August 2007" "Django Project" "" -.SH "NAME" -daily_cleanup.py \- Database clean-up for the Django Web framework -.SH "SYNOPSIS" -.B daily_cleanup.py - -.SH "DESCRIPTION" -Removes stale session data from a Django database. This means, any session data -which has an expiry date prior to the date the script is run. -.sp -The script can be run manually or can be scheduled to run at regular -intervals as a -.BI cron -job. - -.SH "ENVIRONMENT" -.TP -.I DJANGO_SETTINGS_MODULE -This environment variable defines the settings module to be read. -It should be in Python-import form, e.g. "myproject.settings". - -.SH "SEE ALSO" -The sessions documentation: -.sp -.I http://docs.djangoproject.com/en/dev/topics/http/sessions/ - -.SH "AUTHORS/CREDITS" -Originally developed at World Online in Lawrence, Kansas, USA. Refer to the -AUTHORS file in the Django distribution for contributors. - -.SH "LICENSE" -New BSD license. For the full license text refer to the LICENSE file in the -Django distribution. - diff --git a/parts/django/docs/man/django-admin.1 b/parts/django/docs/man/django-admin.1 deleted file mode 100644 index 016c80f..0000000 --- a/parts/django/docs/man/django-admin.1 +++ /dev/null @@ -1,226 +0,0 @@ -.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" "] [" "appname appname appname.Model ..." "]" -Outputs to standard output all data in the database associated with the named -application(s). -.TP -.BI flush -Returns the database to the state it was in immediately after syncdb was -executed. -.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 [" "appname ..." "]" -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" "]" -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 "reset [" "appname ..." "]" -Executes -.B sqlreset -for the given app(s) in the current database. -.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" "] [" "\-\-adminmedia=ADMIN_MEDIA_PATH" "] [" "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 [" "appname ..." "]" -Prints the CREATE TABLE SQL statements for the given app name(s). -.TP -.BI "sqlall [" "appname ..." "]" -Prints the CREATE TABLE, initial\-data and CREATE INDEX SQL statements for the -given model module name(s). -.TP -.BI "sqlclear [" "appname ..." "]" -Prints the DROP TABLE SQL statements for the given app name(s). -.TP -.BI "sqlcustom [" "appname ..." "]" -Prints the custom SQL statements for the given app name(s). -.TP -.BI "sqlflush [" "appname ..." "]" -Prints the SQL statements that would be executed for the "flush" -command. -.TP -.BI "sqlindexes [" "appname ..." "]" -Prints the CREATE INDEX SQL statements for the given model module name(s). -.TP -.BI "sqlinitialdata [" "appname ..." "]" -Prints the initial INSERT SQL statements for the given app name(s). -.TP -.BI "sqlreset [" "appname ..." "]" -Prints the DROP TABLE SQL, then the CREATE TABLE SQL, for the given app -name(s). -.TP -.BI "sqlsequencereset [" "appname ..." "]" -Prints the SQL statements for resetting PostgreSQL sequences for the -given app name(s). -.TP -.BI "startapp [" "appname" "]" -Creates a Django app directory structure for the given app name in -the current directory. -.TP -.BI "startproject [" "projectname" "]" -Creates a Django project directory structure for the given project name -in the current directory. -.TP -.BI syncdb -Creates the database tables for all apps in INSTALLED_APPS whose tables -haven't already been created. -.TP -.BI "test [" "\-\-verbosity" "] [" "\-\-failfast" "] [" "appname ..." "]" -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 \-\-verbosity=VERBOSITY -Verbosity level: 0=minimal output, 1=normal output, 2=all output. -.TP -.I \-\-adminmedia=ADMIN_MEDIA_PATH -Specifies the directory from which to serve admin media when using the development server. -.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 (default: ".html", separate multiple -extensions with commas, or use -e multiple times). -.TP -.I \-s, \-\-symlinks -Follows symlinks to directories when examining source code and templates for -translation strings. -.TP -.I \-i, \-\-ignore=PATTERN -Ignore files or directories matching this glob-style pattern. Use multiple -times to ignore more. -.TP -.I \-\-no\-default\-ignore -Don't ignore the common private glob-style patterns 'CVS', '.*' and '*~'. -.TP -.I \-a, \-\-all -Process all available locales when using makemessages..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". -.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". -.TP - -.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. - diff --git a/parts/django/docs/man/gather_profile_stats.1 b/parts/django/docs/man/gather_profile_stats.1 deleted file mode 100644 index fc56ee2..0000000 --- a/parts/django/docs/man/gather_profile_stats.1 +++ /dev/null @@ -1,26 +0,0 @@ -.TH "gather_profile_stats.py" "1" "August 2007" "Django Project" "" -.SH "NAME" -gather_profile_stats.py \- Performance analysis tool for the Django Web -framework -.SH "SYNOPSIS" -.B python gather_profile_stats.py -.I <path> - -.SH "DESCRIPTION" -This utility script aggregates profiling logs generated using Python's -hotshot profiler. The sole command-line argument is the full path to the -directory containing the profiling logfiles. - -.SH "SEE ALSO" -Discussion of profiling Django applications on the Django project's wiki: -.sp -.I http://www.djangoproject.com/wiki/ProfilingDjango - -.SH "AUTHORS/CREDITS" -Originally developed at World Online in Lawrence, Kansas, USA. Refer to the -AUTHORS file in the Django distribution for contributors. - -.SH "LICENSE" -New BSD license. For the full license text refer to the LICENSE file in the -Django distribution. - |