Django

Code

Ticket #5180: make-messages.1

File make-messages.1, 2.1 kB (added by Nick Efford <nick@efford.org>, 1 year ago)

man page for make-messages.py

Line 
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 [options] -l
7 .I <language>
8 .sp
9 .B make-messages.py [options] -a
10
11 .SH "DESCRIPTION"
12 This script creates or updates one or more message files for a Django app,
13 a Django project or the Django framework itself.  It should be run from one
14 of three places: the root directory of a Django app; the root directory
15 of a Django project; or the root django directory (the one in your PYTHONPATH,
16 not the root of a Subversion checkout).
17 .sp
18 When run with the -l flag and a language code (in locale format), the script
19 will run over the source tree of your app, your project or Django itself
20 (depending on where it is invoked), pulling out all strings marked for
21 translation and creating or updating a message file for the specified
22 language.  (See Django's internationalization documentation for details of
23 where this file is created.)  Translations can be added to this message file
24 using a regular text editor.
25 .sp
26 When run with the -a flag, the script will process the source tree and
27 create/update message files for all languages supported by Django.
28
29 .SH "OPTIONS"
30 .TP
31 .I \-d <domain>
32 Specifies the domain.  Valid domains are 'django' or 'djangojs', depending on
33 whether you wish to generate translation strings for the Python or JavaScript
34 components of your app, your project or the framework itself.  The default
35 domain is 'django'.
36 .TP
37 .I \-v
38 Run verbosely.
39
40 .SH "ENVIRONMENT"
41 .TP
42 .I DJANGO_SETTINGS_MODULE
43 This environment variable defines the settings module to be read.
44 It should be in Python-import form, e.g. "myproject.settings".
45
46 .SH "SEE ALSO"
47 The internationalization documentation:
48 .sp
49 .I http://www.djangoproject.com/documentation/i18n/
50
51 .SH "AUTHORS/CREDITS"
52 Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
53 AUTHORS file in the Django distribution for contributors.
54
55 .SH "LICENSE"
56 New BSD license. For the full license text refer to the LICENSE file in the
57 Django distribution.