summaryrefslogtreecommitdiffstats
path: root/src/README.txt
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2005-03-05 21:31:30 (GMT)
committerSteven Knight <knight@baldmt.com>2005-03-05 21:31:30 (GMT)
commit37f7563ea516a39234fc91a8ffd9cf22d9258e8b (patch)
tree165ab8ab18b63079883e02dccc84c03992cefc16 /src/README.txt
parentf7230b12d84220342c2671276beec9a9d590ce22 (diff)
downloadSCons-37f7563ea516a39234fc91a8ffd9cf22d9258e8b.zip
SCons-37f7563ea516a39234fc91a8ffd9cf22d9258e8b.tar.gz
SCons-37f7563ea516a39234fc91a8ffd9cf22d9258e8b.tar.bz2
Enhance setup.py to install troff man pages on UNIX/Linux.
Diffstat (limited to 'src/README.txt')
-rw-r--r--src/README.txt16
1 files changed, 12 insertions, 4 deletions
diff --git a/src/README.txt b/src/README.txt
index e31fb21..1264571 100644
--- a/src/README.txt
+++ b/src/README.txt
@@ -87,10 +87,18 @@ provided Python-standard setup script as follows:
# python setup.py install
If this is the first time you are installing SCons on your system,
-the above command will install the scons script in the default system
-script directory (/usr/bin or C:\Python*\Scripts, for example) and the
-build engine in an appropriate stand-alone SCons library directory
-(/usr/lib/scons or C:\Python*\scons, for example).
+the above command will install:
+
+ -- the scons script in the default system script directory (/usr/bin
+ or C:\Python*\Scripts, for example);
+
+ -- the build engine in an appropriate stand-alone SCons library
+ directory (/usr/lib/scons or C:\Python*\scons, for example);
+
+ -- on UNIX or Linux systems, the troff-formatted man pages in an
+ appropriate directory (/usr/share/man/man1 or /usr/man/man1,
+ for example). This can be disabled by specifying the
+ "--no-install-doc" option on the command line.
Note that, by default, SCons does not install its library in the
standard Python library directories. If you want to be able to use the