Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

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
  • Loading branch information...
commit e0c1ca7ef0e883eb33c2d1ab34f1ab8ae9e67266 1 parent 4d42dc3
Malcolm Tredinnick authored
1  AUTHORS
@@ -102,6 +102,7 @@ answer newbie questions, and generally made Django that much better:
102 102
     dusk@woofle.net
103 103
     Andy Dustman <farcepest@gmail.com>
104 104
     Clint Ecker
  105
+    Nick Efford <nick@efford.org>
105 106
     eibaan@gmail.com
106 107
     enlight
107 108
     Enrico <rico.bl@gmail.com>
40  docs/man/compile-messages.1
... ...
@@ -0,0 +1,40 @@
  1
+.TH "compile-messages.py" "1" "August 2007" "Django Project" ""
  2
+.SH "NAME"
  3
+compile-messages.py \- Internationalization utility for the Django
  4
+web framework
  5
+.SH "SYNOPSIS"
  6
+.B compile-messages.py \fR[-l <locale>]
  7
+
  8
+.SH "DESCRIPTION"
  9
+A Django-customised wrapper around gettext's \fBmsgfmt\fR command. Generates
  10
+binary message catalogs (.mo files) from textual translation descriptions (.po
  11
+files).
  12
+.sp
  13
+The script should be invoked after running
  14
+.BI make-messages.py,
  15
+in the same directory from which
  16
+.BI make-messages.py
  17
+was invoked.
  18
+
  19
+.SH "OPTIONS"
  20
+.TP
  21
+.I \-l <locale>
  22
+Compile the message catalogs for a specific locale. If this option is omitted,
  23
+all message catalogs are (re-)compiled.
  24
+
  25
+.SH "SEE ALSO"
  26
+The man page for
  27
+.BI msgfmt
  28
+from the GNU gettext utilities, and the internationalization documentation
  29
+for Django:
  30
+.sp
  31
+.I http://www.djangoproject.com/documentation/i18n/
  32
+
  33
+.SH "AUTHORS/CREDITS"
  34
+Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
  35
+AUTHORS file in the Django distribution for contributors.
  36
+
  37
+.SH "LICENSE"
  38
+New BSD license. For the full license text refer to the LICENSE file in the
  39
+Django distribution.
  40
+
34  docs/man/daily_cleanup.1
... ...
@@ -0,0 +1,34 @@
  1
+.TH "daily_cleanup.py" "1" "August 2007" "Django Project" ""
  2
+.SH "NAME"
  3
+daily_cleanup.py \- Database clean-up for the Django web framework
  4
+.SH "SYNOPSIS"
  5
+.B daily_cleanup.py
  6
+
  7
+.SH "DESCRIPTION"
  8
+Removes stale session data from a Django database. This means, any session data
  9
+which has an expiry date prior to the date the script is run.
  10
+.sp
  11
+The script can be run manually or can be scheduled to run at regular
  12
+intervals as a
  13
+.BI cron
  14
+job.
  15
+
  16
+.SH "ENVIRONMENT"
  17
+.TP
  18
+.I DJANGO_SETTINGS_MODULE
  19
+This environment variable defines the settings module to be read.
  20
+It should be in Python-import form, e.g. "myproject.settings".
  21
+
  22
+.SH "SEE ALSO"
  23
+The sessions documentation:
  24
+.sp
  25
+.I http://www.djangoproject.com/documentation/sessions/
  26
+
  27
+.SH "AUTHORS/CREDITS"
  28
+Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
  29
+AUTHORS file in the Django distribution for contributors.
  30
+
  31
+.SH "LICENSE"
  32
+New BSD license. For the full license text refer to the LICENSE file in the
  33
+Django distribution.
  34
+
26  docs/man/gather_profile_stats.1
... ...
@@ -0,0 +1,26 @@
  1
+.TH "gather_profile_stats.py" "1" "August 2007" "Django Project" ""
  2
+.SH "NAME"
  3
+gather_profile_stats.py \- Performance analysis tool for the Django web
  4
+framework
  5
+.SH "SYNOPSIS"
  6
+.B python gather_profile_stats.py
  7
+.I <path>
  8
+
  9
+.SH "DESCRIPTION"
  10
+This utility script aggregates profiling logs generated using Python's
  11
+hotshot profiler. The sole command-line argument is the full path to the
  12
+directory containing the profiling logfiles.
  13
+
  14
+.SH "SEE ALSO"
  15
+Discussion of profiling Django applications on the Django project's wiki:
  16
+.sp
  17
+.I http://www.djangoproject.com/wiki/ProfilingDjango
  18
+
  19
+.SH "AUTHORS/CREDITS"
  20
+Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
  21
+AUTHORS file in the Django distribution for contributors.
  22
+
  23
+.SH "LICENSE"
  24
+New BSD license. For the full license text refer to the LICENSE file in the
  25
+Django distribution.
  26
+
62  docs/man/make-messages.1
... ...
@@ -0,0 +1,62 @@
  1
+.TH "make-messages.py" "1" "August 2007" "Django Project" ""
  2
+.SH "NAME"
  3
+make-messages.py \- Internationalization utility for the Django
  4
+web framework
  5
+.SH "SYNOPSIS"
  6
+.B make-messages.py\fR [\-a] [\-v] [\-l <locale>] [\-d <domain>]
  7
+
  8
+.SH "DESCRIPTION"
  9
+This script creates or updates one or more message files for a Django app,
  10
+a Django project or the Django framework itself.  It should be run from one
  11
+of three places: the root directory of a Django app; the root directory
  12
+of a Django project; or the root django directory (the one in your PYTHONPATH,
  13
+not the root of a Subversion checkout).
  14
+.sp
  15
+The script will run over the source tree of an application, project or Django
  16
+itself (depending on where it is invoked), pulling out all strings marked for
  17
+translation and creating or updating a standard PO-format message file for the
  18
+specified language. Refer to Django's internationalization documentation for
  19
+details of where this file is created.
  20
+.sp
  21
+The \fI\-a\fR and \fI\-l\fR options are used to control whether message
  22
+catalogs are created for all locales, or just a single one.
  23
+
  24
+.SH "OPTIONS"
  25
+.TP
  26
+.I \-a
  27
+Run make-messages for all locales specified in the Django settings file. Cannot
  28
+be used in conjuntion with \fI\-l\fR.
  29
+.TP
  30
+.I \-d <domain>
  31
+Specifies the translation domain to use. Valid domains are \fIdjango\fR or
  32
+\fIdjangojs\fR, depending on whether you wish to generate translation strings
  33
+for the Python or JavaScript components of your app, your project or the
  34
+framework itself.  The default domain is \fIdjango\fR.
  35
+.TP
  36
+.I \-l <locale>
  37
+Extract messages for a particular locale.
  38
+.TP
  39
+.I \-v
  40
+Run verbosely.
  41
+
  42
+.SH "ENVIRONMENT"
  43
+.TP
  44
+.I DJANGO_SETTINGS_MODULE
  45
+This environment variable defines the settings module to be read.
  46
+It should be in Python-import form, e.g. "myproject.settings".
  47
+
  48
+.SH "SEE ALSO"
  49
+The Django internationalization documentation:
  50
+.sp
  51
+.I http://www.djangoproject.com/documentation/i18n/
  52
+.sp
  53
+The PO file format is documented in the GNU gettext documentation.
  54
+
  55
+.SH "AUTHORS/CREDITS"
  56
+Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
  57
+AUTHORS file in the Django distribution for contributors.
  58
+
  59
+.SH "LICENSE"
  60
+New BSD license. For the full license text refer to the LICENSE file in the
  61
+Django distribution.
  62
+

0 notes on commit e0c1ca7

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