python-support/trunk/update-python-modules.8

.TH UPDATE-PYTHON-MODULES 8 "18 Feb 2009"
.\" Please adjust this date whenever revising the manpage.
.SH NAME
update-python-modules \- byte-compile python modules
.SH SYNOPSIS
.B update-python-modules
.RI [ options "] [" package.public " [...]]"
.SH DESCRIPTION
The
.B update-python-modules
command is part of the
.B python-support
bundle.
.PP
.B update-python-modules
is responsible for the byte-compilation of python modules. When used in
byte-compilation mode, it will byte-compile modules references in the
files given on the command line. When used in installation mode, it will
byte-compile them once for each installed python version, and will make
them available for all of them.
.PP
At each invocation, with or without arguments,
.B update-python-modules
will check for installed python versions, and will build or remove
modules according to new or removed versions since the last time it was
run.
.SH ARGUMENTS
Arguments must be files or directories located in the
.I /usr/share/python-support
directory. Depending on their extension, they are treated differently.
.TP
.IR package .public
A file listing public modules to install for each version. These modules
must lie in
.I /usr/share/pyshared
or
.IR /usr/lib/pyshared .
.TP
.IR package .private
A file listing private modules to byte-compile for one Python version.
.TP
.IR package /
A legacy directory hierarchy of public modules. The C extensions and 
portions that change with the Python version are to be found in
.IR /usr/lib/python-support/python X.Y / package / .
.TP
.IR package.dirs
A legacy file listing directories where to find private modules.
.SH OPTIONS
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-verbose
Detail all actions while they are performed.
.TP
.B \-b, \-\-bytecompile
Only accept to work on private modules. When given this option, 
.B update-python-modules
will fail if passed references to public modules.
.TP
.B \-i, \-\-install
Only accept to work on public modules. When given this option, 
.B update-python-modules
will fail if passed references to public modules.
.TP
.B \-c, \-\-clean
Clean modules instead of installing them.
.TP
.B \-a, \-\-rebuild\-all
Rebuild all private modules. This is necessary when the default python
version was changed, for example.
\.TP
.B \-f, \-\-force\-rebuild\-all
Clean all modules (public and private), and rebuild them.
.SH FILES
.TP
.IR /usr/lib/pymodules/python X.Y /
These directories contain the byte-compiled modules for version
.RI python X.Y .
.SH SEE ALSO
/usr/share/doc/python-support/README.gz
.SH AUTHOR
Josselin Mouette <joss@debian.org>.
1	.TH UPDATE-PYTHON-MODULES 8 "18 Feb 2009"
2	.\" Please adjust this date whenever revising the manpage.
3	.SH NAME
4	update-python-modules \- byte-compile python modules
5	.SH SYNOPSIS
6	.B update-python-modules
7	.RI [ options "] [" package.public " [...]]"
8	.SH DESCRIPTION
9	The
10	.B update-python-modules
11	command is part of the
12	.B python-support
13	bundle.
14	.PP
15	.B update-python-modules
16	is responsible for the byte-compilation of python modules. When used in
17	byte-compilation mode, it will byte-compile modules references in the
18	files given on the command line. When used in installation mode, it will
19	byte-compile them once for each installed python version, and will make
20	them available for all of them.
21	.PP
22	At each invocation, with or without arguments,
23	.B update-python-modules
24	will check for installed python versions, and will build or remove
25	modules according to new or removed versions since the last time it was
26	run.
27	.SH ARGUMENTS
28	Arguments must be files or directories located in the
29	.I /usr/share/python-support
30	directory. Depending on their extension, they are treated differently.
31	.TP
32	.IR package .public
33	A file listing public modules to install for each version. These modules
34	must lie in
35	.I /usr/share/pyshared
36	or
37	.IR /usr/lib/pyshared .
38	.TP
39	.IR package .private
40	A file listing private modules to byte-compile for one Python version.
41	.TP
42	.IR package /
43	A legacy directory hierarchy of public modules. The C extensions and
44	portions that change with the Python version are to be found in
45	.IR /usr/lib/python-support/python X.Y / package / .
46	.TP
47	.IR package.dirs
48	A legacy file listing directories where to find private modules.
49	.SH OPTIONS
50	.TP
51	.B \-h, \-\-help
52	Show summary of options.
53	.TP
54	.B \-v, \-\-verbose
55	Detail all actions while they are performed.
56	.TP
57	.B \-b, \-\-bytecompile
58	Only accept to work on private modules. When given this option,
59	.B update-python-modules
60	will fail if passed references to public modules.
61	.TP
62	.B \-i, \-\-install
63	Only accept to work on public modules. When given this option,
64	.B update-python-modules
65	will fail if passed references to public modules.
66	.TP
67	.B \-c, \-\-clean
68	Clean modules instead of installing them.
69	.TP
70	.B \-a, \-\-rebuild\-all
71	Rebuild all private modules. This is necessary when the default python
72	version was changed, for example.
73	\.TP
74	.B \-f, \-\-force\-rebuild\-all
75	Clean all modules (public and private), and rebuild them.
76	.SH FILES
77	.TP
78	.IR /usr/lib/pymodules/python X.Y /
79	These directories contain the byte-compiled modules for version
80	.RI python X.Y .
81	.SH SEE ALSO
82	/usr/share/doc/python-support/README.gz
83	.SH AUTHOR
84	Josselin Mouette <joss@debian.org>.