Ticket #3549: README.diff

File README.diff, 8.7 KB (added by matt@…, 19 years ago)

Path for README

Line 
1--- README.orig Fri Apr 29 17:53:10 2005
2+++ README      Wed Jun 15 12:14:03 2005
3@@ -1,68 +1,79 @@
4 WHAT IS THE DARWIN PORTS SYSTEM
5 
6-    DarwinPorts is a software build, install, and packaging infrastructure
7-designed to meet the same functionality requirements as the FreeBSD ports
8-architecture while maintaining extensibility for future enhancement.
9-
10-    DarwinPorts currently builds and runs on MacOS X 10.2 (Darwin 6.0) and
11-MacOS X 10.3 (Darwin 7.0).  The system is portable, written in TCL with a
12-limited set of TCL extensions in C.
13+       DarwinPorts is a software build, install, and packaging
14+       infrastructure designed to meet the same functionality requirements
15+       as the FreeBSD ports architecture while maintaining extensibility
16+       for future enhancement.
17+
18+       DarwinPorts currently builds and runs on Mac OS X 10.2 (Darwin
19+       6.0), Mac OS X 10.3 (Darwin 7.0.0) and Mac OS X 10.4 (Darwin
20+       8.0.0). The system is portable, written in TCL with a limited set
21+       of TCL extensions in C.
22+
23+               The "DarwinPorts User Guide" is available at:
24+               http://darwinports.opendarwin.org/docs
25+
26+       For in-depth documentation on the internals of the ports system
27+       architecture, refer to base/doc/INTERNALS.
28+
29+       Please note that DarwinPorts is split into two parts.  The "darwin
30+       ports infrastructure", which lives in the base/ subdirectory and is
31+       the only mandatory component of the system, and the "dports"
32+       directory which contains the actual ported software descriptions.
33+       The latter is optional and can be either fetched on demand over the
34+       net or a local copy can be used.  See documentation on ${prefix}
35+       etc/ports/sources.conf below.
36 
37-    The "DarwinPorts User Guide" is available at:
38-       http://darwinports.opendarwin.org/docs
39-
40-    For in-depth documentation on the internals of the ports system
41-architecture, refer to base/doc/INTERNALS.
42-
43-    Please note that DarwinPorts is split into two parts.  The "darwin ports
44-infrastructure", which lives in the base/ subdirectory and is the only
45-mandatory component of the system, and the "dports" directory which contains
46-the actual ported software descriptions.  The latter is optional and can be
47-either fetched on demand over the net or a local copy can be used.  See
48-documentation on ${prefix}/etc/ports/sources.conf below.
49 
50 INSTALLATION
51 
52        For platform specific instructions, read base/doc/README.platforms.
53 
54-    Installation Steps:
55+       Installation Steps:
56 
57        1. cd base/
58           ./configure
59                Switch to the base/ directory and run the configure-script.
60-               Optionally parameters can be passed to the configure-script
61+               Optionally parameters can be passed to the configure-script
62                (see below).
63     
64        2. make
65                Run 'make' to compile all necessary software.
66               
67        3. sudo make install
68-               Run 'sudo make install' to install DarwinPorts on your system.
69+               Run 'sudo make install' to install DarwinPorts on your
70+               system.
71 
72        4. [optional] edit ${prefix}/etc/ports/ports.conf
73-               The ${prefix}/etc/ports/ports.conf configuration file defines several
74-               configuration options for the DarwinPorts infrastructure. If
75-               you wish to change installation paths or the location at
76-               which various port system specific data is stored, change the
77-               following settings:
78-
79-               portdbpath      Specifies path to store ports system specific
80-                               data.
81-               prefix          Specifies directory in which to install ports.
82+               The ${prefix}/etc/ports/ports.conf configuration file
83+               defines several configuration options for the DarwinPorts
84+               infrastructure. If you wish to change installation paths or
85+               the location at which various port system specific data is
86+               stored, change the following settings:
87+
88+                       portdbpath      Specifies path to store ports
89+                                       system specific data.
90+
91+                       prefix          Specifies directory in which to
92+                                       install ports.
93 
94        5. [optional] edit ${prefix}/etc/ports/sources.conf
95-               The ${prefix}/etc/ports/sources.conf file lists the location of both
96-               local and remote port software hierarchies. If the
97-               --with-dports-dir=DIR argument was not specified for the
98-               ./configure script, the default dports-tree
99-               (darwinports/dports, the copy from which you install) will be
100-               added to sources.conf.
101-
102-    All necessary code and TCL will be compiled and installed as follows:
103-       [Mac OS X 10.3] /Library/Tcl/darwinports1.0
104-       [Mac OS X 10.2] /System/Library/Tcl/darwinports1.0
105-       [FreeBSD] /usr/local/lib/tcl8.3/darwinports1.0
106-           - TCL library for interfacing with the DarwinPorts System
107+               The ${prefix}/etc/ports/sources.conf file lists the
108+               location of both local and remote port softwarehierarchies.
109+               If the --with-dports-dir=DIR argument was not specified for
110+               the ./configure script, the default dports-tree
111+               (darwinports/dports, the copy from which you install) will
112+               be added to sources.conf.
113+
114+       All necessary code and TCL will be compiled and installed as
115+       follows:
116+
117+       [Mac OS X 10.2] /System/Library/Tcl/darwinports1.0
118+       [Mac OS X 10.3] /Library/Tcl/darwinports1.0
119+       [Mac OS X 10.4] /Library/Tcl/darwinports1.0
120+       [FreeBSD]       /usr/local/lib/tcl8.3/darwinports1.0
121+                       - TCL library for interfacing with the DarwinPorts
122+                       System.
123 
124        ${prefix} is set to /opt/local but can be overridden by changing
125        directory to the base/ directory and running ./configure
126@@ -83,49 +94,54 @@
127 
128 USING THE PORT COMMAND
129 
130-    If you haven't already, add /opt/local/bin to your path (or ${prefix}/bin
131-if you've elected to install DarwinPorts somewhere else).
132-
133-       If you're unsure how and using Panther (OS X 10.3), add the following
134-line to your ~/.profile file.  If this file does not exist, create it. (This
135-also applies if you're using a bourne shell in Jaguar.)
136+       If you haven't already, add /opt/local/bin to your path (or
137+       ${prefix}/bin if you've elected to install DarwinPorts somewhere
138+       else).
139+
140+       If you're unsure how and using Panther (OS X 10.3), add the
141+       following line to your ~/.profile file. If this file does not
142+       exist, create it. (This also applies if you're using a bourne shell
143+       in Jaguar.)
144       
145-       export PATH=$PATH:/opt/local/bin
146+               export PATH=$PATH:/opt/local/bin
147 
148-       If using Jaguar (OS X 10.2), add the following line to your ~/.cshrc file.
149-If this file does not exist, create it. (This also applies if you're using tcsh in Panther.)
150+       If using Jaguar (OS X 10.2), add the following line to your
151+       ~/.cshrc file. If this file does not exist, create it. (This also
152+       applies if you're using tcsh in Panther.)
153 
154-       set path=($path /opt/local/bin)
155+               set path=($path /opt/local/bin)
156       
157-    Your changes will not take effect until you have opened a new shell.
158+       Your changes will not take effect until you have opened a new
159+       shell.
160 
161-    The following command will build and install a port:
162+       The following command will build and install a port:
163 
164-       port install <portname>
165+               port install <portname>
166 
167-    To find a specific port, try using "port search".
168+       To find a specific port, try using "port search".
169 
170-       port search vi
171+               port search vi
172 
173-    Please refer to the port(1) man page for complete documentation on the port
174-    command.
175+       Please refer to the port(1) man page for complete documentation on
176+       the port command.
177 
178-    It is also possible to do operations, like building or fetching, for
179-    all ports on the system using the portall command.  It takes essentially
180-    the same arguments as the port command but operates iteratively on every
181-    port in dports/.
182+       It is also possible to do operations, like building or fetching,
183+       for all ports on the system using the portall command. It takes
184+       essentially the same arguments as the port command but operates
185+       iteratively on every port in dports/.
186 
187 
188 CREATING NEW PORTS
189 
190-    Ports consist of directory containing both a Portfile and associated
191-files. Currently the only bundled files are patch files, and these are likely
192-to be kept to a minimum.
193-
194-    A Portfile consists of valid TCL, evaluated by a TCL interpreter
195-instantiated by the DarwinPorts System. Portfiles use extremely straight-
196-forward key/value pair syntax, while allowing the author to use the full
197-extent of TCL's functionality where necessary.
198+       Ports consist of directory containing both a Portfile and
199+       associated files. Currently the only bundled files are patch files,
200+       and these are likely to be kept to a minimum.
201+
202+       A Portfile consists of valid TCL, evaluated by a TCL interpreter
203+       instantiated by the DarwinPorts System. Portfiles use extremely
204+       straight-forward key/value pair syntax, while allowing the author
205+       to use the full extent of TCL's functionality where necessary.
206 
207-    To get started, refer to base/doc/exampleport and the portfile(7) man page,
208-or The DarwinPorts Guide, at http://darwinports.opendarwin.org/docs .
209+       To get started, refer to base/doc/exampleport and the portfile(7)
210+       man page, or The DarwinPorts Guide, at:
211+       http://darwinports.opendarwin.org/docs