source: trunk/README @ 6689

Last change on this file since 6689 was 4576, checked in by fkr, 17 years ago

Bug:
Submitted by:
Reviewed by:
Approved by:
Obtained from:

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