mirror of
https://github.com/django/django.git
synced 2025-01-03 15:06:09 +00:00
Fixed #5180 -- Added man pages for remaining files under django/bin/. We still need to rename some binaries before they can be safely installed, I suspect, so these aren't installed by default yet, but the groundwork is there now. Excellent job, Nick Efford!
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5942 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Malcolm Tredinnick
parent
4d42dc3846
commit
e0c1ca7ef0
1
AUTHORS
1
AUTHORS
@ -102,6 +102,7 @@ answer newbie questions, and generally made Django that much better:
|
|||||||
dusk@woofle.net
|
dusk@woofle.net
|
||||||
Andy Dustman <farcepest@gmail.com>
|
Andy Dustman <farcepest@gmail.com>
|
||||||
Clint Ecker
|
Clint Ecker
|
||||||
|
Nick Efford <nick@efford.org>
|
||||||
eibaan@gmail.com
|
eibaan@gmail.com
|
||||||
enlight
|
enlight
|
||||||
Enrico <rico.bl@gmail.com>
|
Enrico <rico.bl@gmail.com>
|
||||||
|
|||||||
40
docs/man/compile-messages.1
Normal file
40
docs/man/compile-messages.1
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
.TH "compile-messages.py" "1" "August 2007" "Django Project" ""
|
||||||
|
.SH "NAME"
|
||||||
|
compile-messages.py \- Internationalization utility for the Django
|
||||||
|
web framework
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.B compile-messages.py \fR[-l <locale>]
|
||||||
|
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
A Django-customised wrapper around gettext's \fBmsgfmt\fR command. Generates
|
||||||
|
binary message catalogs (.mo files) from textual translation descriptions (.po
|
||||||
|
files).
|
||||||
|
.sp
|
||||||
|
The script should be invoked after running
|
||||||
|
.BI make-messages.py,
|
||||||
|
in the same directory from which
|
||||||
|
.BI make-messages.py
|
||||||
|
was invoked.
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.TP
|
||||||
|
.I \-l <locale>
|
||||||
|
Compile the message catalogs for a specific locale. If this option is omitted,
|
||||||
|
all message catalogs are (re-)compiled.
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
The man page for
|
||||||
|
.BI msgfmt
|
||||||
|
from the GNU gettext utilities, and the internationalization documentation
|
||||||
|
for Django:
|
||||||
|
.sp
|
||||||
|
.I http://www.djangoproject.com/documentation/i18n/
|
||||||
|
|
||||||
|
.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.
|
||||||
|
|
||||||
34
docs/man/daily_cleanup.1
Normal file
34
docs/man/daily_cleanup.1
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
.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://www.djangoproject.com/documentation/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.
|
||||||
|
|
||||||
26
docs/man/gather_profile_stats.1
Normal file
26
docs/man/gather_profile_stats.1
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
.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.
|
||||||
|
|
||||||
62
docs/man/make-messages.1
Normal file
62
docs/man/make-messages.1
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
.TH "make-messages.py" "1" "August 2007" "Django Project" ""
|
||||||
|
.SH "NAME"
|
||||||
|
make-messages.py \- Internationalization utility for the Django
|
||||||
|
web framework
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.B make-messages.py\fR [\-a] [\-v] [\-l <locale>] [\-d <domain>]
|
||||||
|
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
This script creates or updates one or more message files for a Django app,
|
||||||
|
a Django project or the Django framework itself. It should be run from one
|
||||||
|
of three places: the root directory of a Django app; the root directory
|
||||||
|
of a Django project; or the root django directory (the one in your PYTHONPATH,
|
||||||
|
not the root of a Subversion checkout).
|
||||||
|
.sp
|
||||||
|
The script will run over the source tree of an application, project or Django
|
||||||
|
itself (depending on where it is invoked), pulling out all strings marked for
|
||||||
|
translation and creating or updating a standard PO-format message file for the
|
||||||
|
specified language. Refer to Django's internationalization documentation for
|
||||||
|
details of where this file is created.
|
||||||
|
.sp
|
||||||
|
The \fI\-a\fR and \fI\-l\fR options are used to control whether message
|
||||||
|
catalogs are created for all locales, or just a single one.
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.TP
|
||||||
|
.I \-a
|
||||||
|
Run make-messages for all locales specified in the Django settings file. Cannot
|
||||||
|
be used in conjuntion with \fI\-l\fR.
|
||||||
|
.TP
|
||||||
|
.I \-d <domain>
|
||||||
|
Specifies the translation domain to use. Valid domains are \fIdjango\fR or
|
||||||
|
\fIdjangojs\fR, depending on whether you wish to generate translation strings
|
||||||
|
for the Python or JavaScript components of your app, your project or the
|
||||||
|
framework itself. The default domain is \fIdjango\fR.
|
||||||
|
.TP
|
||||||
|
.I \-l <locale>
|
||||||
|
Extract messages for a particular locale.
|
||||||
|
.TP
|
||||||
|
.I \-v
|
||||||
|
Run verbosely.
|
||||||
|
|
||||||
|
.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 Django internationalization documentation:
|
||||||
|
.sp
|
||||||
|
.I http://www.djangoproject.com/documentation/i18n/
|
||||||
|
.sp
|
||||||
|
The PO file format is documented in the GNU gettext documentation.
|
||||||
|
|
||||||
|
.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.
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user