source: trunk/README @ 14895

Last change on this file since 14895 was 12689, checked in by jmpp, 14 years ago

Bug: 3549
Submitted by: matt@
Reviewed by: jmpp@

Formating changes to the main README file and mention of Mac OS X 10.4
I can't imagine doing this for the Spanish file.. speak any Spanish Matt??

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