macports/macports-guide
0
0
Fork 0
mirror of https://github.com/macports/macports-guide.git synced 2026-07-12 18:18:46 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc/guide: Removed the data of the new guide as it is now in doc-new, also

Browse Source 
reverted the Makefile to its state before the new guide. I hope this doesn't
cause any problems.

git-svn-id: https://svn.macports.org/repository/macports/trunk/doc@29473 d073be05-634f-4543-b044-5fe20cf6d1d6
This commit is contained in:
Simon Ruderich
2007-09-24 20:14:51 +00:00
parent 1edbf88a5f
commit 2c00d5106c
12 changed files with 1 additions and 5945 deletions
Download Patch File Download Diff File Expand all files Collapse all files
guide/Makefile
+1 -17
View File
@@ -27,32 +27,22 @@
# set XML_DEBUG_CATALOG= to see catalog debugging info
SOURCEDIR?= xml
NEWSOURCEDIR?= new/xml
DOCBOOK_XSL?= ${prefix}/share/xsl/docbook-xsl/
HTMLDIR?= html
NEWHTMLDIR?= new/html
XHTMLDIR?= xhtml
STYLESHEET?= ${DOCBOOK_XSL}/html/chunk.xsl
XSTYLESHEET?= ${DOCBOOK_XSL}/xhtml/chunk.xsl
NEWSTYLESHEET?= ${DOCBOOK_XSL}/xhtml/docbook.xsl
XML_CATALOG_FILES?= ${prefix}/etc/xml/catalog
XML_DEBUG_CATALOG?=
CSS_STYLESHEET?= docbook.css
RESOURCES?= resources/
NEWRESOURCES?= new/resources/
STRINGPARAMS?= --stringparam html.stylesheet ${CSS_STYLESHEET} --stringparam chunk.section.depth 0
NEWSTRINGPARAMS?= --stringparam html.stylesheet ${CSS_STYLESHEET} \
--stringparam section.autolabel 1 \
--stringparam toc.section.depth 1 \
--stringparam generate.toc "book toc" \
--stringparam section.label.includes.component.label 1
.PHONY : all
.PHONY : clean
#.PHONY : install
.PHONY : html
.PHONY : xhtml
.PHONY : new
.PHONY : check
.PHONY : tidy
@@ -68,12 +58,6 @@ xhtml:
cp ${RESOURCES}${CSS_STYLESHEET} ${XHTMLDIR}
xsltproc --xinclude ${STRINGPARAMS} -o "${XHTMLDIR}/" "${XSTYLESHEET}" "${SOURCEDIR}/guide.xml"
new:
mkdir -p ${NEWHTMLDIR}
cp ${NEWRESOURCES}${CSS_STYLESHEET} ${NEWHTMLDIR}
cp ${NEWRESOURCES}/images/* ${NEWHTMLDIR}
xsltproc --xinclude ${NEWSTRINGPARAMS} -o "${NEWHTMLDIR}/guide.html" "${NEWSTYLESHEET}" "${NEWSOURCEDIR}/guide.xml"
all: html xhtml tidy
tidy:
@@ -85,6 +69,6 @@ tidy:
-tidy -quiet -modify -indent -xml ${XHTMLDIR}/*
clean:
rm -fr ${HTMLDIR} ${XHTMLDIR} ${NEWHTMLDIR}
rm -fr ${HTMLDIR} ${XHTMLDIR}
include ../../base/Mk/macports.autoconf.mk
guide/new/resources/docbook.css
-204
View File
@@ -1,204 +0,0 @@
/*
* MacPorts Guide Stylesheet
*/
/*
CSS design by Mark Duling
*/
div.mediaobject {
text-align: center;
margin: auto;
border: thin black inset;
}
.emphasis { font-weight: bold ; }
a:link { color: #6298E5; text-decoration: none; }
a:visited { color: #6298E5; text-decoration: none;}
a:hover { text-decoration: underline; }
.filename { color: #8B1A1A; }
span.term { font-weight: bold; }
span.guilabel { font-weight: bold; }
span.guimenu { font-weight: bold; }
.programlisting {
font-family: monospace;
font-size: medium;
background-color: #E6E6E6;
border: thin black inset }
.screen {
font-family: monospace;
font-size: medium;
border: thin black inset;
background-color: white; }
div.screenshot div.mediaobject {
text-align: center;
margin: auto }
body {
font-family: Verdana, Arial, sans-serif;
font-size: 14px;
line-height: 1.4;
color: #696969;
}
div.note h3.title { color: #C00; }
.author {
font-size: 14px;
color: #6298E5;
font-weight: bold;
}
.copyright {
font-size: 12px;
font-family: times;
}
div.book div.titlepage h1 {
font-family: Verdana, Arial, Utopia, sans-serif;
font-size: 24pt;
color: black;
font-weight: bold;
text-align: left;
}
div.book div.titlepage h2 {
font-family: Verdana, Arial, Utopia, sans-serif;
font-size: 18pt;
color: black;
font-weight: bold;
text-align: left;
}
div.section div.titlepage h2 {
font-family: Verdana, Arial, Utopia, sans-serif;
font-size: 16pt;
color: black;
text-align: left;
}
div.section div.titlepage h3 {
font-family: Verdana, Arial, Utopia, sans-serif;
font-size: 14pt;
color: black;
font-weight: bold;
text-align: left;
}
div.section div.titlepage h4 {
font-family: Verdana, Arial, Utopia, sans-serif;
font-size: 12pt;
color: black;
font-weight: bold;
text-align: left;
}
div.mediaobject {
text-align: center;
margin: auto;
}
p { margin-bottom: 14pt; }
div.toc {
border-width: 1px;
border-color: black;
border-style: solid;
/* background-color: #C2CAD8; Color of macosforge.org sidebar */
background-color: #9FB6CD;
background-repeat: no-repeat;
background-position: center top;
font-size: 10px;
font-family: Verdana, Arial, sans-serif;
color: black;
left: 8px;
width: 234px;
padding-left: 2px;
padding-top: 0px;
height: 96%;
float: left;
overflow: scroll;
position: fixed;
top: 12px;
/* IE hack */
position: expression("absolute");
top: expression(document.body.scrollTop+this.offsetHeight-this.offsetHeight);
}
/* Definitions for non-Safari/non-IE toc sections */
div.toc dt {
font-size: 12px;
line-height: 22px;
}
/* Definitions for non-Safari/non-IE toc subsections */
div.toc dd dl dt {
font-size: 11px;
line-height: 14px;
}
/* Definitions for toc sections using Safari Stokely hack */
html*.toc dt {
/* Seen by Safari */
font-size: 14px;
line-height: 16px;
/* Seen by IE */
_font-size: 14px;
_line-height: 22px;
}
/* Definitions for toc subsections using Safari Stokely hack */
html*.toc dd dl dt {
/* Seen by Safari */
font-size: 11px;
line-height: 13px;
padding-bottom: 0px;
/* Seen by IE */
_font-size: 11px;
_line-height: 14px;
_padding-bottom: 0px;
}
/* TOC All Links */
/* div.toc a:link { color: royalblue; } */
/* div.toc a:hover { color: #D00; } */
/* div.toc a:visited { color: black; text-decoration: none; } */
/* TOC Section Links */
div.toc dt a:link { color: #F4F6F8; text-decoration: none; }
div.toc dt a:hover { color: gray; }
div.toc dt a:visited { color: #F4F6F8; text-decoration: none; }
/* TOC Subsubsection Links */
div.toc dd dl dt a:link { color: black; text-decoration: none; }
div.toc dd dl dt a:hover { color: gray; }
div.toc dd dl dt a:visited { color: black; text-decoration: none; }
div.book {
margin-left: 247px;
}
/*
div.toc:before {
font-family: Palatino, Bookman, serif;
font-size: 16px;
font-weight: bold;
text-align: center;
display: block;
color: black;
content: "MacPorts Guide Contents";
} */
guide/new/resources/images/trac-default.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 32 KiB

guide/new/xml/glossary.xml
-479
View File
@@ -1,479 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="guide-terms">
<title>MacPorts Guide Terms</title>
<glossary id="glossary">
<glossdiv id="terms">
<title>MacPorts Guide Terms</title>
<glossentry>
<glossterm>activate phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>automake</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>autoconf</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>API</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>BSD Unix</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>CVS</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>destroot phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port binary</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>build</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>build phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>checksum</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>checksum phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>compile</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>configure</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>configure phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>dependency</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>destroot phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>diff</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>extract phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>fetch phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>free software</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>global keyword</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>gunzip</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>keyword</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>keyword argument modifier</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>keyword list modifier</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>library</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>MacPorts</glossterm>
<glossdef>
<para>A system for compiling, installing, and managing free and open
source software comprised of an infrastructure called MacPorts base
and a collection of ports. MacPorts current port collection defines
the software may be installed.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>open source software</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>patch phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>patch file</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>pextlib</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port command</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port image</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port maintainer</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port phase</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>port phase keyword</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>PortGroup</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>Portfile</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>registry</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>rsync</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>selfupdate</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>shell</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>StartupItem</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>subversion</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>sync</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>tar</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>Tcl</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>Tcl extension</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>Trac</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>Unix</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>unzip</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>variant</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>Xcode Tools</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>X11</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
<glossentry>
<glossterm>zip</glossterm>
<glossdef>
<para />
</glossdef>
</glossentry>
</glossdiv>
</glossary>
</chapter>
guide/new/xml/guide.xml
-64
View File
@@ -1,64 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book>
<title>MacPorts Guide</title>
<bookinfo>
<author>
<firstname>Mark</firstname>
<surname>Duling</surname>
</author>
<author>
<honorific>Dr</honorific>
<firstname>Michael</firstname>
<surname>Maibaum</surname>
<othername role="mi">A</othername>
</author>
<author>
<firstname>Will</firstname>
<surname>Barton</surname>
</author>
<copyright>
<year>2007</year>
<holder>The MacPorts Project</holder>
</copyright>
<copyright>
<year>2002, 2003, 2004</year>
<holder>The OpenDarwin Project</holder>
</copyright>
<legalnotice>
<para></para>
</legalnotice>
</bookinfo>
<xi:include href="intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="installing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="portfiledev.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="portfileref.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="internals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="glossary.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>
guide/new/xml/installing.xml
-270
View File
@@ -1,270 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="installing">
<title>Installing MacPorts</title>
<para>This chapter show you how to install MacPorts and its prerequisites
step-by-step. Note that sections 1 through 3 are Mac OS X specific. If you
wish to install MacPorts on FreeBSD, first make sure you have gcc and X11
installed, and then begin with section <link
linkend="installing.source">Install MacPorts - Source</link>.</para>
<section id="installing.xcode">
<title>Install Xcode Tools</title>
<para>To install Xcode Tools and the X11 SDK, follow these steps.</para>
<orderedlist>
<listitem>
<para>Download and install the latest version of <ulink
url="http://developer.apple.com/tools/xcode/">Xcode Tools</ulink>—do
not install an older version from the OS X 10.4 install disk or some
ports may fail to install.</para>
</listitem>
<listitem>
<para>Run the binary installer.</para>
</listitem>
<listitem>
<para>Click the button Customize, expand the Applications category and
click the check box beside X11 SDK to add it to the default
items.</para>
</listitem>
<listitem>
<para>Click "Install" to install Xcode Tools and the X11 SDK.</para>
</listitem>
</orderedlist>
<note>
<para>Xcode Tools are not updated via OS X's Software Update
utility.</para>
</note>
</section>
<section id="installing.x11">
<title>Install X11</title>
<para>On OS X 10.4, Apple's X Window System (X11) is an optional install
(Apple's X11 is currently recommended over the MacPorts X11 port). It is
recommended that you install it even if you don't plan to run X11
applications immediately.</para>
<orderedlist>
<listitem>
<para>Insert the "Mac OS X Install Disk 1" and run the package named
"Optional Installs".</para>
</listitem>
<listitem>
<para>At the software selection window expand the Applications
category and click the check box beside X11 (and nothing else).</para>
</listitem>
<listitem>
<para>Click the Install button to install X11.</para>
</listitem>
<listitem>
<para>Drag the <filename>/Applications/Utilities/X11</filename> icon
to your dock —you must open X11 before launching an X11
application.</para>
</listitem>
</orderedlist>
<note>
<para>X11 and the X11SDK (from Xcode Tools) are both required for X11
apps. To verify the presence of both, check for files
<filename>X11User.pkg</filename> and <filename>X11SDK.pkg</filename> in
<filename>/Library/Receipts/</filename>.</para>
</note>
<section id="installing.x11.settings">
<title>Optional X11 Settings</title>
<para>To launch X11 applications directly from an X11 window (instead of
a terminal window), you need to have the MacPorts paths imported into
X11 sessions when they are opened. This is a two step process.</para>
<para>First, tell X11 about the <filename>~/.profile</filename> file
that will be created after you install MacPorts. Do this by editing the
file <filename>/etc/X11/xinit/xinitrc</filename> and adding this line
near the top.</para>
<programlisting>source ~/.profile</programlisting>
<para>Now finish the process by making subsequent X11 sessions opened
using the menu bar respect your <filename>.profile</filename>
file.</para>
<orderedlist>
<listitem>
<para>Open X11 and select "Customize Menu ..." from the Applications
menu.</para>
</listitem>
<listitem>
<para>Double-click the menu item "Terminal" and change: "xterm" to
"xterm -ls"</para>
</listitem>
<listitem>
<para>Click "Done" to save the change.</para>
</listitem>
</orderedlist>
</section>
</section>
<section id="installing.binary">
<title>Install MacPorts - Binary</title>
<para>If you wish to install MacPorts to a path other than
<filename>/opt/local</filename> do not install the MacPorts binary —skip
this section and <link linkend="installing.source">install MacPorts from
the source code</link>. The MacPorts binary installer will only install to
<filename>/opt/local</filename>.</para>
<orderedlist>
<listitem>
<para>Download the latest MacPorts .dmg disk image from the <ulink
url="http://svn.macports.org/repository/macports/downloads/">MacPorts
download directory</ulink>.</para>
</listitem>
<listitem>
<para>Run the binary installer.</para>
</listitem>
<listitem>
<para>Perform the default “easy” install.</para>
</listitem>
</orderedlist>
<note>
<para>A MacPorts <link linkend="installing.selfupdate">selfupdate</link>
operation will automatically update to the latest release if the binary
.dmg image is behind the latest released tarball.</para>
</note>
</section>
<section id="installing.source">
<title>Install MacPorts - Source</title>
<para>If you installed MacPorts using the binary installer, skip this
section. Installing from source on Mac OS X is only necessary if you wish
to install to a path other than <filename>/opt/local</filename>, or if you
wish to install a non-release version of MacPorts base. You must also
install MacPorts from source if you wish to install MacPorts on a platform
other than Mac OS X.</para>
<orderedlist>
<listitem>
<para>Download and unzip the latest MacPorts tarball from the <ulink
url="http://svn.macports.org/repository/macports/downloads/">MacPorts
download directory</ulink>.</para>
</listitem>
<listitem>
<para>Perform these commands in a terminal window, substituting a real
path for NEW_PREFIX if you wish to use a path other than
<filename>/opt/local/</filename>.</para>
<programlisting><prompt>%%</prompt> <userinput>cd ~/MacPorts-1.x.x/</userinput>
<prompt>%%</prompt> <userinput>./configure</userinput> --prefix=NEW_PREFIX (setting prefix is optional)
<prompt>%%</prompt> <userinput>make</userinput>
<prompt>%%</prompt> <userinput>sudo make install</userinput></programlisting>
</listitem>
</orderedlist>
<section id="installing.source.multiple">
<title>Multiple MacPorts Installs</title>
<para>Occasionally a MacPorts developer may wish to install more than
one copy of MacPorts on the same host, possibly to test two different
versions of MacPorts. But only one copy of MacPorts may use the default
MacPorts Tcl library path <filename>/Library/Tcl</filename>, so for a
second installation use the <literal>--with-tclpackage</literal> switch
set to any newly created (empty) directory, say
/Library/Tcl/macports-new. Also, the standard MacPorts binary path must
not be present during the installation of the second instance. To
install a second instance of MacPorts, follow these steps.</para>
<programlisting><prompt>%%</prompt> <userinput>export PATH=/bin:/sbin:/usr/bin:/usr/sbin</userinput>
<prompt>%%</prompt> <userinput>cd ~/MacPorts-1.x.x/</userinput>
<prompt>%%</prompt> <userinput>./configure --prefix=NEW_PREFIX --with-tcl-package=NEW_TCLPACKAGE</userinput>
<prompt>%%</prompt> <userinput>make</userinput>
<prompt>%%</prompt> <userinput>sudo make install</userinput>
</programlisting>
</section>
</section>
<section id="installing.shell">
<title>Set the Bash Shell</title>
<para>The MacPorts binary installer places a <filename>.profile</filename>
file in your home directory (view files with a dot using <command>ls
-a</command>). The contents of the <filename>~/.profile</filename> adds
the MacPorts paths in front of the standard Unix paths for the default
Bash shell so that MacPorts libraries will take precedence over
vendor-supplied libraries if both are present.</para>
<para>The path statement in the MacPorts-installed .profile is set as
shown.</para>
<programlisting>export PATH=/opt/local/bin:/opt/local/sbin:$PATH</programlisting>
<para>You must add this <varname>DISPLAY</varname> variable for
X11.</para>
<programlisting>export DISPLAY=:0.0</programlisting>
<para>Add the <varname>EDITOR</varname> variable to use your favorite text
editor. A complete <filename>~/.profile</filename> file with the added
variables is shown below.</para>
<programlisting>export PATH=/opt/local/bin:/opt/local/sbin:$PATH
export DISPLAY=:0.0
export EDITOR=/usr/bin/pico
</programlisting>
<para>Changes to <filename>~/.profile</filename> do not take effect until
a new terminal session is opened. Type <command>env</command> in the
terminal to verify the current environment settings. Example output of
<command>env</command> is below.</para>
<screen>TERM_PROGRAM=Apple_Terminal
TERM=xterm-color
SHELL=/bin/bash
TERM_PROGRAM_VERSION=133
USER=joebob
__CF_USER_TEXT_ENCODING=0x1FC:0:0
PATH=/opt/local/bin:/opt/local/sbin:/bin:/sbin:/usr/bin:/usr/sbin
PWD=/Users/joebob
EDITOR=/usr/bin/pico
SHLVL=1
HOME=/Users/joebob
LOGNAME=joebob
DISPLAY=:0.0
SECURITYSESSIONID=b0cea0
_=/usr/bin/env</screen>
<note>
<para>If you have either a <filename>.bash_login</filename> or a
<filename>.bash_profile</filename> file in your home directory, they may
take precedence over <filename>.profile</filename>. You may either
remove the previously used file, or add the contents of
<filename>.profile</filename> to it.</para>
</note>
</section>
<section id="installing.selfupdate">
<title>MacPorts Selfupdate</title>
<para>You must always do a selfupdate after a new MacPorts install, and
you should also do it frequently thereafter. See <link
linkend="using.port.selfupdate">selfupdate</link> —one of several <link
linkend="using.port">port commands</link>.</para>
</section>
</chapter>
guide/new/xml/internals.xml
-926
View File
File diff suppressed because it is too large Load Diff
guide/new/xml/intro.xml
-81
View File
@@ -1,81 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="introduction">
<title>Introduction</title>
<para>MacPorts is a system for compiling, installing, and managing free and
open source software. MacPorts may be conceptually divided into two main
parts: the infrastructure, known as MacPorts base, and the set of available
ports. A MacPorts port is a set of specifications contained in a <link
linkend="development.introduction">Portfile</link> that defines an
application, its characteristics, and any files or special instructions
required to install it, so MacPorts may automatically fetch, patch, compile,
and install ported software.</para>
<para>However, installing software using MacPorts instead of doing it
manually brings advantages apart from scripted installs for individual
applications. For example, MacPorts:</para>
<itemizedlist>
<listitem>
<para>Installs automatically any required support software, known as
"dependencies", for a given port.</para>
</listitem>
<listitem>
<para>Provides automatic uninstalls and upgrades for installed
ports.</para>
</listitem>
<listitem>
<para>Confines ported software to a private "sandbox" that keeps it from
intermingling with your operating system and its vendor-supplied
software to prevent them from becoming corrupted.</para>
</listitem>
<listitem>
<para>Allows you to create pre-compiled binary installers of ported
applications to quickly install software on computers without compiling
from source code.</para>
</listitem>
</itemizedlist>
<para>MacPorts is developed on Mac OS X, though it is designed to be
portable so it can work on other Unix-like systems, especially those
descended from the Berkeley Software Distribution (BSD).</para>
<section id="introduction.conventions">
<title>Document Conventions</title>
<para>The MacPorts Guide uses some notational conventions to distinguish
between terminal input/output, file text, and other special text
types.</para>
<itemizedlist>
<listitem>
<para>Terminal I/O and file text.</para>
<programlisting><prompt>%% </prompt><userinput>Commands to be typed into a terminal window.</userinput></programlisting>
<screen>Command output to a terminal window.</screen>
<programlisting>File text.</programlisting>
</listitem>
<listitem>
<para>Other special text types.</para>
<para>A hyperlink: <ulink
url="http://en.wikipedia.org/wiki/Spontaneous_combustion">spontaneous
combustion</ulink>.</para>
<para>A file: <filename>/var/log/system.log</filename>.</para>
<para>A command: <command>ifconfig</command>.</para>
<para>An option: port <option>install</option></para>
</listitem>
</itemizedlist>
</section>
</chapter>
guide/new/xml/portfiledev.xml
-696
View File
File diff suppressed because it is too large Load Diff
guide/new/xml/portfileref.xml
-2172
View File
File diff suppressed because it is too large Load Diff
guide/new/xml/project.xml
-438
View File
@@ -1,438 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="project">
<title>MacPorts Project</title>
<para>The MacPorts Project uses a system called <ulink
url="http://trac.edgewall.org/">Trac</ulink> to file tickets to report bugs
and enhancement requests. Trac also provides an interface to browse the
<ulink url="http://trac.macports.org/projects/macports/browser/">MacPorts
Subversion repository</ulink>. Though anyone may search Trac for tickets,
you must <ulink
url="http://www.macports.org/wp-register.php">register</ulink> for a Trac
account to create tickets.</para>
<section id="project.tickets">
<title>Creating Trac Tickets</title>
<para>Once you are logged into Trac, you may click <emphasis>View Tickets
-&gt; New Ticket</emphasis> and you will be presented with a new ticket
window shown in the graphic below. Follow the Trac ticket guidelines below
to fill out the form.</para>
<screenshot>
<screeninfo>A new Trac ticket</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="trac-default.png" />
</imageobject>
</mediaobject>
</screenshot>
<section id="project.tickets.guidelines">
<title>Trac Ticket Guidelines</title>
<para>There are certain conventions used to ensure that Trac tickets
convey as much accurate information as possible so problems and
contributions may be acted upon efficiently.</para>
<itemizedlist>
<listitem>
<para><guilabel>Short Summary:</guilabel> [port] [version] [concise
description]</para>
<itemizedlist>
<listitem>
<para>Example: "rrdtool-1.2.23 Configure error - build
failure"</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><guilabel>Type:</guilabel> There are two main types of
tickets.</para>
<itemizedlist>
<listitem>
<para><guimenu>defect</guimenu> - The default; any port/MacPorts
build/runtime failures and/or documentation corrections.</para>
</listitem>
<listitem>
<para><guimenu>enhancement</guimenu> - Tickets, with or without
patches, created to enhance something that isn't failing its
intended purpose.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><guilabel>Full Description:</guilabel> All details that might
be relevant to someone reading the ticket. <ulink
url="http://trac.macports.org/projects/macports/wiki/WikiFormatting">Wiki
formatting</ulink> or attached log files should be used for large
text blocks.</para>
</listitem>
<listitem>
<para><guilabel>Priority:</guilabel> Assign a priority level to the
ticket.</para>
<itemizedlist>
<listitem>
<para><guimenu>High</guimenu> - For MacPorts base build/runtime
failures and critical enhancement requests.</para>
</listitem>
<listitem>
<para><guimenu>Normal</guimenu> - The default. For normal port
failures, non-critical enhancement requests, non-critical port
failures.</para>
</listitem>
<listitem>
<para><guimenu>Low</guimenu> - For mostly cosmetic improvements,
documentation corrections/improvements, etc.</para>
</listitem>
<listitem>
<para>Blank - Anything that doesn't fit the categories high,
normal, or low.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><guilabel>Component:</guilabel> Set what part of the MacPorts
project the ticket is to be filed against.</para>
<itemizedlist>
<listitem>
<para><guimenu>ports</guimenu> - Tickets related to
ports.</para>
</listitem>
<listitem>
<para><guimenu>base</guimenu> - Tickets related to MacPorts base
code.</para>
</listitem>
<listitem>
<para><guimenu>guide</guimenu> - Documentation enhancements and
error corrections, or patches to the MacPorts Guide.</para>
</listitem>
<listitem>
<para><guimenu>www</guimenu> - MacPorts website enhancements and
error corrections.</para>
</listitem>
<listitem>
<para><guimenu>infrastructure</guimenu> - Reserved for MacPorts
Portmgr team members.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><guilabel>Assign To:</guilabel> For tickets on ports, select
the port maintainer's email address (use <command>port info
&lt;portname&gt;</command>). If the maintainer's email address is
<email>nomaintainer@macports.org</email>, select
<email>macports-dev@lists.macosforge.org</email>.</para>
</listitem>
<listitem>
<para><guilabel>Milestone:</guilabel> This is a ticket category that
allows for search and sorting tickets efficiently.</para>
<itemizedlist>
<listitem>
<para><guimenu>Documentation</guimenu> - for tickets relating to
the documentation for Macports, including the MacPorts guide,
wiki and man pages.</para>
</listitem>
<listitem>
<para><guimenu>MacPorts base enhancements</guimenu> - for
tickets requesting or providing improvements to the
functionality of the MacPorts system.</para>
</listitem>
<listitem>
<para><guimenu>MacPorts base bugs</guimenu> - for tickets
reporting or fixing bugs in the MacPorts system.</para>
</listitem>
<listitem>
<para><guimenu>MacPorts x.y</guimenu> - indicates tickets
against the MacPorts base code that have been accepted and
scheduled for inclusion or fixing in the x.y MacPorts release
series.</para>
<note>
<para>This milestone may only be applied by MacPorts team
members.</para>
</note>
</listitem>
<listitem>
<para><guimenu>Port Bugs</guimenu> - for tickets reporting or
fixing bugs in ports provided by MacPorts.</para>
</listitem>
<listitem>
<para><guimenu>Port Enhancements</guimenu> - for submissions
providing enhancements to ports provided by MacPorts.</para>
</listitem>
<listitem>
<para><guimenu>Port Requests</guimenu> - for requests for ports
to be added to MacPorts.</para>
</listitem>
<listitem>
<para><guimenu>Port Submissions</guimenu> - for submissions that
add a port to MacPorts.</para>
</listitem>
<listitem>
<para><guimenu>Port Updates</guimenu> - for submissions that
update a port provided by MacPorts.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><guilabel>Version:</guilabel> Select the MacPorts version you
are using when it is applicable.</para>
</listitem>
<listitem>
<para><guilabel>Keywords:</guilabel> Type any keywords that might
help when searching for tickets (portname, type of problem,
etc).</para>
</listitem>
<listitem>
<para><guilabel>Cc:</guilabel> The reporter should enter his or her
email address and the maintainer's email address to notify both
parties when updates to the ticket occur. This is important, because
Trac currently only sends emails to addresses on the Cc list, not to
the reporter or the assignee.</para>
</listitem>
<listitem>
<para><guilabel>Attachments:</guilabel> Files may be attached only
after a ticket has been submitted. Once the ticket has been created
you will see the file attachment button.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="project.contributing">
<title>Contributing to MacPorts</title>
<para>You may contribute new ports and port updates to current ports using
Trac tickets.</para>
<!-- Should we have similar sections about committing to base sources and
documentation, or alternatively add this to the following? -->
<section id="project.contributing.new">
<title>New Ports</title>
<para>Ports are contributed by following these steps. See Ticket
Submission Guidelines above for a description of all fields.</para>
<orderedlist>
<listitem>
<para>Create a Trac ticket.</para>
</listitem>
<listitem>
<para>Set the type to <guilabel>enhancement</guilabel>.</para>
</listitem>
<listitem>
<para>Set the milestone to <guilabel>Port
Submissions</guilabel>.</para>
</listitem>
<listitem>
<para>Attach the <filename>Portfile</filename> and any required
patchfiles to the ticket.</para>
</listitem>
</orderedlist>
</section>
<section id="project.contributing.updates">
<title>Port Updates</title>
<para>Portfile updates should always be contributed as
<filename>Portfile</filename> patches. Ports are contributed by
following these steps. See Ticket Submission Guidelines above for a
description of all fields.</para>
<orderedlist>
<listitem>
<para>Create a <filename>Portfile</filename> patch with your changes
as described in Portfile Development.</para>
</listitem>
<listitem>
<para>Create a Trac ticket.</para>
</listitem>
<listitem>
<para>Set the type to <guilabel>enhancement</guilabel>.</para>
</listitem>
<listitem>
<para>Set the milestone to <guilabel>Port
Enhancements</guilabel>.</para>
</listitem>
<listitem>
<para>Attach your Portfile patch file and any new or changed patch
files (don't patch patches) to the ticket.</para>
</listitem>
</orderedlist>
</section>
</section>
<section id="project.update-policies">
<title>Port Update Policies</title>
<para>Port maintainers normally are given commit privileges to the
Subversion repository so they can make updates to their own ports.
However, the MacPorts project does not restrict commit privileges for
maintainers, so before a person other than a port's maintainer updates a
port it is a good practice to inform a port's maintainer. See details
below.</para>
<section id="project.update-policies.nonmaintainer">
<title>Non-Maintainer Port Updates</title>
<para>If you have a port update or bugfix for a port you do not
maintain, to respect the rights of the port maintainer you should follow
the following guidelines:</para>
<orderedlist>
<listitem>
<para>If a port's maintainer is
<email>nomaintainer@macports.org</email>, you may feel free to make
updates and/or take maintainership of the port.</para>
</listitem>
<listitem>
<para>If a port's maintainer contains the address
<email>openmaintainer@macports.org</email>, this means that the
author allows minor updates to the port without contacting him
first. But permission should still be sought for major
changes.</para>
</listitem>
<listitem>
<para>Create patch file(s) as necessary, attach them to a Trac
ticket, and assign the ticket to the maintainer and Cc him or
her.</para>
</listitem>
<listitem>
<para>Wait for a response from the maintainer. The maintainer should
apply the patches and close the ticket within 72 hours.</para>
</listitem>
</orderedlist>
<para>However, for maintained ports without
<email>openmaintainer@macports.org</email>, there are some conditions
under which maintainer permission may be waived:</para>
<itemizedlist>
<listitem>
<para>If the maintainer does not respond within 72 hours, you or
another committer may review the patches and update the port. If you
are not a committer, you may email
<email>macports-dev@lists.macosforge.org</email> and request the
updates be committed.</para>
</listitem>
<listitem>
<para>A port is abandoned by it's current maintainer. A port against
which a Port Abandoned ticket has been filed (see below) can be
updated without contacting the maintainer.</para>
</listitem>
<listitem>
<para>A critical port is broken that affects many users.</para>
</listitem>
</itemizedlist>
</section>
<section id="project.update-policies.abandonment">
<title>Port Abandonment</title>
<para>A port may be considered abandoned if a bug has not been
acknowledged for more than three weeks after a ticket is filed. If this
time period has passed and you wish to initiate the Port Abandonment
protocol and volunteer as the new maintainer:</para>
<orderedlist>
<listitem>
<para>File a new Trac ticket with the summary line [Port
Abandoned].</para>
</listitem>
<listitem>
<para>Refer to the original unacknowledged ticket in the Port
Abandoned ticket.</para>
</listitem>
<listitem>
<para>The Port Abandoned ticket may be closed when the new
maintainer is assigned, and the original ticket with the updates may
be resolved when the updates attached to the original ticket are
committed.</para>
</listitem>
</orderedlist>
</section>
</section>
<section id="project.membership">
<title>MacPorts Membership</title>
<para>A requirement for a person to become a MacPorts committer is to
first become involved and contribute to the project. This may be done by
having a record of contributing to the project in several of the following
ways:</para>
<itemizedlist>
<listitem>
<para>Contributing new ports.</para>
</listitem>
<listitem>
<para>Fixing bugs in existing ports.</para>
</listitem>
<listitem>
<para>Volunteering as a maintainer of non-maintained ports.</para>
</listitem>
<listitem>
<para>Involvement on MacPorts support lists.</para>
</listitem>
</itemizedlist>
<para>To apply for MacPorts commit rights, send a brief email to
<email>macports-mgr@lists.macosforge.org</email> entitled “Request for
commit rights” detailing the reasons for your application and why you
think you deserve commit rights (including evidence of contributions to
MacPorts as described above).</para>
</section>
</chapter>
guide/new/xml/using.xml
-598
View File
File diff suppressed because it is too large Load Diff