cpython-lru_cache-weakref: Misc/python.man annotate

annotate Misc/python.man @ 84224:dfead0696a71 3.3

Add -b and -X options to python man page. Patch contributed by Corey Brune.

author	Senthil Kumaran <senthil@uthcode.com>
date	Wed, 19 Jun 2013 22:19:46 -0500
parents	c1c632e2560d
children	4b33f74ab0f1

rev	line source
19740 8e6e248dfdd8 Change the date field to use $Date$ so it won't be outrageously out of Guido van Rossum <guido@python.org> parents: 19739 diff changeset	1 .TH PYTHON "1" "$Date$"
33685 9a38625fa2b0 Add helpful comment Andrew M. Kuchling <amk@amk.ca> parents: 33684 diff changeset	2
52363 daf661d05442 Merged revisions 70518,70521,70590,70594-70595 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 51805 diff changeset	3 .\" To view this file while editing, run it through groff:
daf661d05442 Merged revisions 70518,70521,70590,70594-70595 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 51805 diff changeset	4 .\" groff -Tascii -man python.man \| less
33685 9a38625fa2b0 Add helpful comment Andrew M. Kuchling <amk@amk.ca> parents: 33684 diff changeset	5
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	6 .SH NAME
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	7 python \- an interpreted, interactive, object-oriented programming language
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	8 .SH SYNOPSIS
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	9 .B python
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	10 [
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	11 .B \-B
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	12 ]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	13 [
84224 dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	14 .B \-b
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	15 ]
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	16 [
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	17 .B \-d
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	18 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	19 [
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	20 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	21 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	22 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	23 .B \-h
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	24 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	25 [
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	26 .B \-i
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	27 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	28 [
84224 dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	29 .B \-m
33682 37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	30 .I module-name
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	31 ]
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	32 .br
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	33 [
84224 dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	34 .B \-q
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	35 ]
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	36 [
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	37 .B \-O
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	38 ]
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	39 [
69733 c57fdce01eb8 #11971: fix man page; it's -OO not -O0 R David Murray <rdmurray@bitdance.com> parents: 65273 diff changeset	40 .B \-OO
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	41 ]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	42 [
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	43 .B \-s
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	44 ]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	45 [
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	46 .B \-S
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	47 ]
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	48 [
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	49 .B \-u
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	50 ]
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	51 .br
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	52 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	53 .B \-v
14602 24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	54 ]
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	55 [
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	56 .B \-V
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	57 ]
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	58 [
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	59 .B \-W
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	60 .I argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	61 ]
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	62 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	63 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	64 ]
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	65 [
84224 dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	66 [
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	67 .B \-X
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	68 .I option
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	69 ]
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	70 .B \-?
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	71 ]
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	72 .br
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	73 [
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	74 .B \-c
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	75 .I command
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	76 \|
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	77 .I script
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	78 \|
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	79 \-
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	80 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	81 [
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	82 .I arguments
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	83 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	84 .SH DESCRIPTION
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	85 Python is an interpreted, interactive, object-oriented programming
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	86 language that combines remarkable power with very clear syntax.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	87 For an introduction to programming in Python you are referred to the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	88 Python Tutorial.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	89 The Python Library Reference documents built-in and standard types,
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	90 constants, functions and modules.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	91 Finally, the Python Reference Manual describes the syntax and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	92 semantics of the core language in (perhaps too) much detail.
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	93 (These documents may be located via the
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	94 .B "INTERNET RESOURCES"
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	95 below; they may be installed on your system as well.)
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	96 .PP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	97 Python's basic power can be extended with your own modules written in
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	98 C or C++.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	99 On most systems such modules may be dynamically loaded.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	100 Python is also adaptable as an extension language for existing
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	101 applications.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	102 See the internal documentation for hints.
17315 6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	103 .PP
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	104 Documentation for installed Python modules and packages can be
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	105 viewed by running the
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	106 .B pydoc
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	107 program.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	108 .SH COMMAND LINE OPTIONS
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	109 .TP
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	110 .B \-B
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	111 Don't write
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	112 .I .py[co]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	113 files on import. See also PYTHONDONTWRITEBYTECODE.
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	114 .TP
84224 dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	115 .B \-b
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	116 Issue warnings about str(bytes_instance), str(bytearray_instance)
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	117 and comparing bytes/bytearray with str. (-bb: issue errors)
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	118 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	119 .BI "\-c " command
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	120 Specify the command to execute (see next section).
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	121 This terminates the option list (following options are passed as
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	122 arguments to the command).
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	123 .TP
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	124 .B \-d
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	125 Turn on parser debugging output (for wizards only, depending on
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	126 compilation options).
1559 df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	127 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	128 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	129 Ignore environment variables like PYTHONPATH and PYTHONHOME that modify
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	130 the behavior of the interpreter.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	131 .TP
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	132 .B \-h ", " \-? ", "\-\-help
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	133 Prints the usage for the interpreter executable and exits.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	134 .TP
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	135 .B \-i
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	136 When a script is passed as first argument or the \fB\-c\fP option is
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	137 used, enter interactive mode after executing the script or the
1559 df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	138 command. It does not read the $PYTHONSTARTUP file. This can be
df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	139 useful to inspect global variables or a stack trace when a script
df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	140 raises an exception.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	141 .TP
33682 37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	142 .BI "\-m " module-name
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	143 Searches
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	144 .I sys.path
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	145 for the named module and runs the corresponding
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	146 .I .py
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	147 file as a script.
37c65a6b2ef7 Add -m to man page Andrew M. Kuchling <amk@amk.ca> parents: 29264 diff changeset	148 .TP
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	149 .B \-O
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	150 Turn on basic optimizations. This changes the filename extension for
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	151 compiled (bytecode) files from
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	152 .I .pyc
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	153 to \fI.pyo\fP. Given twice, causes docstrings to be discarded.
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	154 .TP
69733 c57fdce01eb8 #11971: fix man page; it's -OO not -O0 R David Murray <rdmurray@bitdance.com> parents: 65273 diff changeset	155 .B \-OO
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	156 Discard docstrings in addition to the \fB-O\fP optimizations.
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	157 .TP
66687 f35a6d7e325f #1772833: add -q command line option. Georg Brandl <georg@python.org> parents: 65271 diff changeset	158 .B \-q
f35a6d7e325f #1772833: add -q command line option. Georg Brandl <georg@python.org> parents: 65271 diff changeset	159 Do not print the version and copyright messages. These messages are
f35a6d7e325f #1772833: add -q command line option. Georg Brandl <georg@python.org> parents: 65271 diff changeset	160 also suppressed in non-interactive mode.
f35a6d7e325f #1772833: add -q command line option. Georg Brandl <georg@python.org> parents: 65271 diff changeset	161 .TP
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	162 .B \-s
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	163 Don't add user site directory to sys.path.
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	164 .TP
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	165 .B \-S
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	166 Disable the import of the module
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	167 .I site
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	168 and the site-dependent manipulations of
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	169 .I sys.path
68859 a364719e400a Do not touch sys.path when site is imported and python was started with -S. Éric Araujo <merwok@netwok.org> parents: 68257 diff changeset	170 that it entails. Also disable these manipulations if
a364719e400a Do not touch sys.path when site is imported and python was started with -S. Éric Araujo <merwok@netwok.org> parents: 68257 diff changeset	171 .I site
a364719e400a Do not touch sys.path when site is imported and python was started with -S. Éric Araujo <merwok@netwok.org> parents: 68257 diff changeset	172 is explicitly imported later.
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	173 .TP
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	174 .B \-u
65111 a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from Georg Brandl <georg@python.org> parents: 58612 diff changeset	175 Force the binary I/O layers of stdin, stdout and stderr to be unbuffered.
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from Georg Brandl <georg@python.org> parents: 58612 diff changeset	176 The text I/O layer will still be line-buffered.
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from Georg Brandl <georg@python.org> parents: 58612 diff changeset	177 .\" Note that there is internal buffering in readlines() and
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from Georg Brandl <georg@python.org> parents: 58612 diff changeset	178 .\" file-object iterators ("for line in sys.stdin") which is not
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from Georg Brandl <georg@python.org> parents: 58612 diff changeset	179 .\" influenced by this option. To work around this, you will want to use
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from Georg Brandl <georg@python.org> parents: 58612 diff changeset	180 .\" "sys.stdin.readline()" inside a "while 1:" loop.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	181 .TP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	182 .B \-v
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	183 Print a message each time a module is initialized, showing the place
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	184 (filename or built-in module) from which it is loaded. When given
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	185 twice, print a message for each file that is checked for when
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	186 searching for a module. Also provides information on module cleanup
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	187 at exit.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	188 .TP
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	189 .B \-V ", " \-\-version
14602 24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	190 Prints the Python version number of the executable and exits.
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	191 .TP
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	192 .BI "\-W " argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	193 Warning control. Python sometimes prints warning message to
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	194 .IR sys.stderr .
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	195 A typical warning message has the following form:
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	196 .IB file ":" line ": " category ": " message.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	197 By default, each warning is printed once for each source line where it
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	198 occurs. This option controls how often warnings are printed.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	199 Multiple
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	200 .B \-W
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	201 options may be given; when a warning matches more than one
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	202 option, the action for the last matching option is performed.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	203 Invalid
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	204 .B \-W
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	205 options are ignored (a warning message is printed about invalid
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	206 options when the first warning is issued). Warnings can also be
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	207 controlled from within a Python program using the
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	208 .I warnings
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	209 module.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	210
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	211 The simplest form of
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	212 .I argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	213 is one of the following
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	214 .I action
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	215 strings (or a unique abbreviation):
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	216 .B ignore
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	217 to ignore all warnings;
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	218 .B default
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	219 to explicitly request the default behavior (printing each warning once
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	220 per source line);
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	221 .B all
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	222 to print a warning each time it occurs (this may generate many
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	223 messages if a warning is triggered repeatedly for the same source
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	224 line, such as inside a loop);
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	225 .B module
54841 f6cb2932022c Merged revisions 73544 via svnmerge from Georg Brandl <georg@python.org> parents: 52363 diff changeset	226 to print each warning only the first time it occurs in each
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	227 module;
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	228 .B once
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	229 to print each warning only the first time it occurs in the program; or
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	230 .B error
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	231 to raise an exception instead of printing a warning message.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	232
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	233 The full form of
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	234 .I argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	235 is
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	236 .IB action : message : category : module : line.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	237 Here,
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	238 .I action
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	239 is as explained above but only applies to messages that match the
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	240 remaining fields. Empty fields match all values; trailing empty
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	241 fields may be omitted. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	242 .I message
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	243 field matches the start of the warning message printed; this match is
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	244 case-insensitive. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	245 .I category
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	246 field matches the warning category. This must be a class name; the
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	247 match test whether the actual warning category of the message is a
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	248 subclass of the specified warning category. The full class name must
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	249 be given. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	250 .I module
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	251 field matches the (fully-qualified) module name; this match is
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	252 case-sensitive. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	253 .I line
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	254 field matches the line number, where zero matches all line numbers and
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	255 is thus equivalent to an omitted line number.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	256 .TP
84224 dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	257 .BI "\-X " option
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	258 Set implementation specific option.
dfead0696a71 Add -b and -X options to python man page. Senthil Kumaran <senthil@uthcode.com> parents: 77524 diff changeset	259 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	260 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	261 Skip the first line of the source. This is intended for a DOS
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	262 specific hack only. Warning: the line numbers in error messages will
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	263 be off by one!
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	264 .SH INTERPRETER INTERFACE
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	265 The interpreter interface resembles that of the UNIX shell: when
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	266 called with standard input connected to a tty device, it prompts for
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	267 commands and executes them until an EOF is read; when called with a
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	268 file name argument or with a file as standard input, it reads and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	269 executes a
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	270 .I script
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	271 from that file;
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	272 when called with
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	273 .B \-c
77524 c1c632e2560d Do not italicize punctuation in python(1) manual page (Matt Kraai). doko@ubuntu.com parents: 75157 diff changeset	274 .IR command ,
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	275 it executes the Python statement(s) given as
77524 c1c632e2560d Do not italicize punctuation in python(1) manual page (Matt Kraai). doko@ubuntu.com parents: 75157 diff changeset	276 .IR command .
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	277 Here
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	278 .I command
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	279 may contain multiple statements separated by newlines.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	280 Leading whitespace is significant in Python statements!
34779 997b255e1ccc fix two typos in python(1) Matthias Klose <doko@ubuntu.com> parents: 33685 diff changeset	281 In non-interactive mode, the entire input is parsed before it is
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	282 executed.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	283 .PP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	284 If available, the script name and additional arguments thereafter are
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	285 passed to the script in the Python variable
77524 c1c632e2560d Do not italicize punctuation in python(1) manual page (Matt Kraai). doko@ubuntu.com parents: 75157 diff changeset	286 .IR sys.argv ,
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	287 which is a list of strings (you must first
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	288 .I import sys
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	289 to be able to access it).
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	290 If no script name is given,
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	291 .I sys.argv[0]
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	292 is an empty string; if
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	293 .B \-c
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	294 is used,
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	295 .I sys.argv[0]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	296 contains the string
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	297 .I '-c'.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	298 Note that options interpreted by the Python interpreter itself
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	299 are not placed in
77524 c1c632e2560d Do not italicize punctuation in python(1) manual page (Matt Kraai). doko@ubuntu.com parents: 75157 diff changeset	300 .IR sys.argv .
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	301 .PP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	302 In interactive mode, the primary prompt is `>>>'; the second prompt
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	303 (which appears when a command is not complete) is `...'.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	304 The prompts can be changed by assignment to
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	305 .I sys.ps1
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	306 or
77524 c1c632e2560d Do not italicize punctuation in python(1) manual page (Matt Kraai). doko@ubuntu.com parents: 75157 diff changeset	307 .IR sys.ps2 .
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	308 The interpreter quits when it reads an EOF at a prompt.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	309 When an unhandled exception occurs, a stack trace is printed and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	310 control returns to the primary prompt; in non-interactive mode, the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	311 interpreter exits after printing the stack trace.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	312 The interrupt signal raises the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	313 .I Keyboard\%Interrupt
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	314 exception; other UNIX signals are not caught (except that SIGPIPE is
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	315 sometimes ignored, in favor of the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	316 .I IOError
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	317 exception). Error messages are written to stderr.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	318 .SH FILES AND DIRECTORIES
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	319 These are subject to difference depending on local installation
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	320 conventions; ${prefix} and ${exec_prefix} are installation-dependent
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	321 and should be interpreted as for GNU software; they may be the same.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	322 The default for both is \fI/usr/local\fP.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	323 .IP \fI${exec_prefix}/bin/python\fP
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	324 Recommended location of the interpreter.
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	325 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	326 .I ${prefix}/lib/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	327 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	328 .I ${exec_prefix}/lib/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	329 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	330 Recommended locations of the directories containing the standard
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	331 modules.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	332 .RE
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	333 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	334 .I ${prefix}/include/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	335 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	336 .I ${exec_prefix}/include/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	337 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	338 Recommended locations of the directories containing the include files
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	339 needed for developing Python extensions and embedding the
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	340 interpreter.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	341 .RE
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	342 .SH ENVIRONMENT VARIABLES
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	343 .IP PYTHONHOME
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	344 Change the location of the standard Python libraries. By default, the
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	345 libraries are searched in ${prefix}/lib/python<version> and
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	346 ${exec_prefix}/lib/python<version>, where ${prefix} and ${exec_prefix}
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	347 are installation-dependent directories, both defaulting to
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	348 \fI/usr/local\fP. When $PYTHONHOME is set to a single directory, its value
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	349 replaces both ${prefix} and ${exec_prefix}. To specify different values
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	350 for these, set $PYTHONHOME to ${prefix}:${exec_prefix}.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	351 .IP PYTHONPATH
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	352 Augments the default search path for module files.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	353 The format is the same as the shell's $PATH: one or more directory
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	354 pathnames separated by colons.
34779 997b255e1ccc fix two typos in python(1) Matthias Klose <doko@ubuntu.com> parents: 33685 diff changeset	355 Non-existent directories are silently ignored.
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	356 The default search path is installation dependent, but generally
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	357 begins with ${prefix}/lib/python<version> (see PYTHONHOME above).
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	358 The default search path is always appended to $PYTHONPATH.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	359 If a script argument is given, the directory containing the script is
2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	360 inserted in the path in front of $PYTHONPATH.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	361 The search path can be manipulated from within a Python program as the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	362 variable
77524 c1c632e2560d Do not italicize punctuation in python(1) manual page (Matt Kraai). doko@ubuntu.com parents: 75157 diff changeset	363 .IR sys.path .
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	364 .IP PYTHONSTARTUP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	365 If this is the name of a readable file, the Python commands in that
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	366 file are executed before the first prompt is displayed in interactive
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	367 mode.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	368 The file is executed in the same name space where interactive commands
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	369 are executed so that objects defined or imported in it can be used
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	370 without qualification in the interactive session.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	371 You can also change the prompts
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	372 .I sys.ps1
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	373 and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	374 .I sys.ps2
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	375 in this file.
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	376 .IP PYTHONY2K
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	377 Set this to a non-empty string to cause the \fItime\fP module to
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	378 require dates specified as strings to include 4-digit years, otherwise
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	379 2-digit years are converted based on rules described in the \fItime\fP
23406 e0ed68adba33 Fix typo Andrew M. Kuchling <amk@amk.ca> parents: 20401 diff changeset	380 module documentation.
20401 b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	381 .IP PYTHONOPTIMIZE
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	382 If this is set to a non-empty string it is equivalent to specifying
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	383 the \fB\-O\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	384 specifying \fB\-O\fP multiple times.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	385 .IP PYTHONDEBUG
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	386 If this is set to a non-empty string it is equivalent to specifying
20401 b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	387 the \fB\-d\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	388 specifying \fB\-d\fP multiple times.
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	389 .IP PYTHONDONTWRITEBYTECODE
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	390 If this is set to a non-empty string it is equivalent to specifying
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	391 the \fB\-B\fP option (don't try to write
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	392 .I .py[co]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	393 files).
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	394 .IP PYTHONINSPECT
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	395 If this is set to a non-empty string it is equivalent to specifying
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	396 the \fB\-i\fP option.
65273 1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	397 .IP PYTHONIOENCODING
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	398 If this is set before running the interpreter, it overrides the encoding used
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	399 for stdin/stdout/stderr, in the syntax
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	400 .IB encodingname ":" errorhandler
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	401 The
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	402 .IB errorhandler
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	403 part is optional and has the same meaning as in str.encode. For stderr, the
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	404 .IB errorhandler
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	405 part is ignored; the handler will always be \'backslashreplace\'.
58612 ce0d4dc488d2 Merged revisions 77877 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 55927 diff changeset	406 .IP PYTHONNOUSERSITE
65273 1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	407 If this is set to a non-empty string it is equivalent to specifying the
1f225d66941a Merged revisions 85436 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 65111 diff changeset	408 \fB\-s\fP option (Don't add the user site directory to sys.path).
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	409 .IP PYTHONUNBUFFERED
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	410 If this is set to a non-empty string it is equivalent to specifying
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	411 the \fB\-u\fP option.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	412 .IP PYTHONVERBOSE
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	413 If this is set to a non-empty string it is equivalent to specifying
20401 b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	414 the \fB\-v\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	415 specifying \fB\-v\fP multiple times.
60436 f369db0d5845 Merged revisions 79878-79880 via svnmerge from Philip Jenvey <pjenvey@underboss.org> parents: 60149 diff changeset	416 .IP PYTHONWARNINGS
f369db0d5845 Merged revisions 79878-79880 via svnmerge from Philip Jenvey <pjenvey@underboss.org> parents: 60149 diff changeset	417 If this is set to a comma-separated string it is equivalent to
f369db0d5845 Merged revisions 79878-79880 via svnmerge from Philip Jenvey <pjenvey@underboss.org> parents: 60149 diff changeset	418 specifying the \fB\-W\fP option for each separate value.
75066 f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	419 .IP PYTHONHASHSEED
75152 198e31774f0f enable hash randomization by default Benjamin Peterson <benjamin@python.org> parents: 75097 diff changeset	420 If this variable is set to "random", a random value is used to seed the hashes
198e31774f0f enable hash randomization by default Benjamin Peterson <benjamin@python.org> parents: 75097 diff changeset	421 of str, bytes and datetime objects.
75066 f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	422
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	423 If PYTHONHASHSEED is set to an integer value, it is used as a fixed seed for
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	424 generating the hash() of the types covered by the hash randomization. Its
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	425 purpose is to allow repeatable hashing, such as for selftests for the
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	426 interpreter itself, or to allow a cluster of python processes to share hash
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	427 values.
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	428
f4b7ecf8a5f8 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime) Georg Brandl <georg@python.org> parents: 69733 diff changeset	429 The integer must be a decimal number in the range [0,4294967295]. Specifying
75152 198e31774f0f enable hash randomization by default Benjamin Peterson <benjamin@python.org> parents: 75097 diff changeset	430 the value 0 will disable hash randomization.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	431 .SH AUTHOR
33684 3e6f56e8104a Take out Guido's name and put in the PSF Andrew M. Kuchling <amk@amk.ca> parents: 33683 diff changeset	432 The Python Software Foundation: http://www.python.org/psf
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	433 .SH INTERNET RESOURCES
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	434 Main website: http://www.python.org/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	435 .br
55927 8bc4c8cac7d7 Merged revisions 74759-74760 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 54841 diff changeset	436 Documentation: http://docs.python.org/py3k/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	437 .br
73785 49d69219fa59 Fix last remaining references to ex-devguide Éric Araujo <merwok@netwok.org> parents: 69734 diff changeset	438 Developer resources: http://docs.python.org/devguide/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	439 .br
55927 8bc4c8cac7d7 Merged revisions 74759-74760 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 54841 diff changeset	440 Downloads: http://python.org/download/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	441 .br
55927 8bc4c8cac7d7 Merged revisions 74759-74760 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 54841 diff changeset	442 Module repository: http://pypi.python.org/
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	443 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	444 Newsgroups: comp.lang.python, comp.lang.python.announce
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	445 .SH LICENSING
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	446 Python is distributed under an Open Source license. See the file
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	447 "LICENSE" in the Python source distribution for information on terms &
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	448 conditions for accessing and otherwise using Python and for a
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	449 DISCLAIMER OF ALL WARRANTIES.

Mercurial > cpython-lru_cache-weakref

annotate Misc/python.man @ 84224:dfead0696a71 3.3