source: trunk/README @ 8465

Last change on this file since 8465 was 8273, checked in by wbb4, 15 years ago

Bug: 2207
Submitted by: skuld@…
Reviewed by:
Approved by:
Obtained from:

Update the README to instruct Jaguar users on what to do in order to disable image functionality so that DarwinPorts works, basically changing "image" install to "direct" in ports.conf.

Also made some cosmetic whitespace changes.

  • Property svn:eol-style set to native
File size: 5.2 KB
Line 
1WHAT IS THE DARWIN PORTS SYSTEM
2
3    DarwinPorts is a software build, install, and packaging infrastructure
4designed to meet the same functionality requirements as the FreeBSD ports
5architecture while maintaining extensibility for future enhancement.
6
7    DarwinPorts currently builds and runs on MacOS X 10.2 (Darwin 6.0) and
8MacOS X 10.3 (Darwin 7.0).  The system is portable, written in TCL with a
9limited set of TCL extensions in C.
10
11    The "DarwinPorts User Guide" is available at:
12        http://www.opendarwin.org/projects/darwinports/guide/
13
14    For in-depth documentation on the internals of the ports system
15architecture, refer to base/doc/INTERNALS.
16
17    Please note that DarwinPorts is split into two parts.  The "darwin ports
18infrastructure", which lives in the base/ subdirectory and is the only
19mandatory component of the system, and the "dports" directory which contains
20the actual ported software descriptions.  The latter is optional and can be
21either fetched on demand over the net or a local copy can be used.  See
22documentation on /etc/ports/sources.conf below.
23
24INSTALLATION
25
26        For platform specific instructions, read base/doc/README.platforms.
27
28    Installation Steps:
29
30        1. cd base/
31           ./configure
32                Switch to the base/ directory and run the configure-script.
33                Optionally parameters can be passed to the configure-script
34                (see below).
35   
36        2. make
37                Run 'make' to compile all necessary software.
38               
39        3. sudo make install
40                Run 'sudo make install' to install DarwinPorts on your system.
41
42        4. [optional] edit /etc/ports/ports.conf
43                The /etc/ports/ports.conf configuration file defines several
44                configuration options for the DarwinPorts infrastructure. If
45                you wish to change installation paths or the location at
46                which various port system specific data is stored, change the
47                following settings:
48
49                portdbpath      Specifies path to store ports system specific
50                                data.
51                prefix          Specifies directory in which to install ports.
52
53                [Required on Mac OS X 10.2]
54                Because Tcl 8.3 on Mac OS X 10.2 does not include the
55                [file link] function used for Port Images, you will need to
56                change the installation type in /etc/ports/ports.conf. 
57                Change the following line:
58                        portinstalltype         image
59                to:     
60                        portinstalltype         direct
61
62        5. [optional] edit /etc/ports/sources.conf
63                The /etc/ports/sources.conf file lists the location of both
64                local and remote port software hierarchies. If the
65                --with-dports-dir=DIR argument was not specified for the
66                ./configure script, the default dports-tree
67                (darwinports/dports, the copy from which you install) will be
68                added to sources.conf.
69
70    All necessary code and TCL will be compiled and installed as follows:
71        [Mac OS X 10.3] /Library/Tcl/darwinports1.0
72        [Mac OS X 10.2] /System/Library/Tcl/darwinports1.0
73        [FreeBSD] /usr/local/lib/tcl8.3/darwinports1.0
74            - TCL library for interfacing with the DarwinPorts System
75
76        PREFIX is set to /opt/local but can be overridden by changing
77        directory to the base/ directory and running ./configure
78        manually with a --prefix argument
79
80        $PREFIX/bin/port
81            - Command line port building utility
82        $PREFIX/share/darwinports/
83            - TCL libraries internal to the ports system
84
85        The following files are provided for customization of the system:
86
87        /etc/ports/ports.conf
88            - User customizable port settings
89        /etc/ports/sources.conf
90            - List of port sources (places to get ports data from)
91
92
93USING THE PORT COMMAND
94
95    If you haven't already, add /opt/local/bin to your path (or $PREFIX/bin
96if you've elected to install DarwinPorts somewhere else).
97
98        If you're using Panther (OS X 10.3), add the following line to your
99~/.profile file.  (This also applies if you're using a bourne shell in
100Jaguar.)
101       
102        export PATH=$PATH:/opt/local/bin
103
104        If you're unsure how, and using Jaguar (OS X 10.2), add the following
105line to your ~/.cshrc file.  (This also applies if you're using tcsh in
106Panther.)
107
108        set path=($path /opt/local/bin)
109       
110    Your changes will not take effect until you have opened a new shell.
111
112    The following command will build and install a port:
113
114        port install <portname>
115
116    To find a specific port, try using "port search".
117
118        port search vi
119
120    Please refer to the port man page for complete documentation on the port
121    command.
122
123    It is also possible to do operations, like building or fetching, for
124    all ports on the system using the portall command.  It takes essentially
125    the same arguments as the port command but operates iteratively on every
126    port in dports/.  When you do a "make clean" from this directory, for
127    example, a "portall clean" is also invoked to completely clean things up.
128
129
130CREATING NEW PORTS
131
132    Ports consist of directory containing both a Portfile and associated
133files. Currently the only bundled files are patch files, and these are likely
134to be kept to a minimum.
135
136    A Portfile consists of valid TCL, evaluated by a TCL interpreter
137instantiated by the DarwinPorts System. Portfiles use extremely straight-
138forward key/value pair syntax, while allowing the author to use the full
139extent of TCL's functionality where necessary.
140
141    To get started, refer to base/doc/exampleport and the portfile(7) man page,
142or The DarwinPorts Guide, at http://darwinports.opendarwin.org/docs.
Note: See TracBrowser for help on using the repository browser.