<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[134971] trunk/base/doc/sources.conf.5.txt</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="https://trac.macports.org/changeset/134971">134971</a></dd>
<dt>Author</dt> <dd>cal@macports.org</dd>
<dt>Date</dt> <dd>2015-04-12 12:07:19 -0700 (Sun, 12 Apr 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>base: document sources.conf, #44530</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkbasedocsourcesconf5txt">trunk/base/doc/sources.conf.5.txt</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbasedocsourcesconf5txtfromrev133158trunkbasedocmacportsconf5txt"></a>
<div class="copfile"><h4>Copied: trunk/base/doc/sources.conf.5.txt (from rev 133158, trunk/base/doc/macports.conf.5.txt) (0 => 134971)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/base/doc/sources.conf.5.txt (rev 0)
+++ trunk/base/doc/sources.conf.5.txt 2015-04-12 19:07:19 UTC (rev 134971)
</span><span class="lines">@@ -0,0 +1,122 @@
</span><ins>+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+sources.conf(5)
+===============
+$Id$
+
+NAME
+----
+sources.conf - port definition configuration file of the MacPorts system
+
+DESCRIPTION
+-----------
+*sources.conf* is the configuration file used by the MacPorts system to locate
+its port definitions. The file is read by the *port* command to find available
+ports and how to install them. Entries in this file are URIs optionally followed
+by flags in square brackets. Each source specification is given on a separate
+line. A grammar in EBNF is given below:
+--------
+<line> ::= <URI> [ '[' <flags> ']' ]
+<flags> ::= <flag> [ ',' [ ' ' | '\t' ] <flags> ]
+<flag> ::= 'default' | 'nosync'
+--------
+
+URI FORMATS
+-----------
+// Set default style for second-level labeled lists in this section
+//:listdef-labeled2.style: horizontal
+
+MacPorts supports a number of different protocols as source descriptions.
+
+'rsync://'::
+ Followed by a server name and a path on this server, this URI instructs
+ MacPorts to fetch the contents of the file or directory referenced by this
+ URI into a path of its own choosing. This is the default method of port tree
+ synchronization and is generally recommended. MacPorts will derive
+ a machine- and architecture-specific URI (in the subdirectory
+ PortIndex_$\{platform\}_$\{os_major\}_$\{os_arch\}/) and attempt to download
+ a pre-generated PortIndex (including the PortIndex.quick file) from there.
+ +
+ *Example*;;
+ rsync://rsync.macports.org/release/tarballs/ports.tar
+ *Default*;;
+ rsync://rsync.macports.org/release/tarballs/ports.tar [default]
+
+'file://'::
+ Followed by an absolute path (which will result in *three* slashes at the
+ beginning of the URI) to a local directory that should be used as port tree.
+ A port index will automatically be generated for this source. Note that
+ MacPorts will try to determine whether the given path is under source
+ control and attempt to update from the default remote server if it is.
+ Currently, Subversion and Git (including git-svn) are supported options. You
+ can add the 'nosync' tag to avoid this behavior.
+ +
+ NOTE: The MacPorts user (usually called 'macports') needs to be able to read
+ and write to this location. This usually means your home directory is not
+ a suitable place for a port tree, unless you adjust permissions accordingly.
+ +
+ *Example*;;
+ file:///opt/dports [nosync,default]
+ *Default*;;
+ none
+
+'http://', 'https://' and 'ftp://'::
+ Followed by a server name and a path on this server, this URI instructs
+ MacPorts to download a tarball snapshot of a ports tree from the URI and
+ extract it to a path of its choice. This possibility is provided as
+ a fallback to users that can use neither rsync nor subversion to sync the
+ MacPorts port tree.
+ +
+ If the tarball contains a pre-built PortIndex and PortIndex.quick file at
+ PortIndex_$\{platform\}_$\{os_major\}_$\{os_arch\}/, those will be used as
+ default. If it does not, MacPorts will build a suitable port index for the
+ local system automatically.
+
+SOURCE FORMATS
+--------------
+Port definition trees can be either directories (e.g. for the 'file://' and
+rsync methods) or tarballs (for HTTP, HTTPS, FTP and rsync). For the directory
+format, no additional verification is performed. Because transfers using rsync
+are not encrypted or authenticated, the use of this setup over rsync is
+discouraged.
+
+If the URI ends with '.tar', MacPorts assumes the source is a tarball and
+attempts to download an additional '.tar.rmd160' signature file. It then uses
+the public keys configured in man:pubkeys.conf[5] to verify this signature to
+ensure the source has not been tampered with. You are strongly encouraged to use
+this setup, and it has been the default for MacPorts since it has been
+introduced.
+
+FLAGS
+-----
+Source specifications support a number of flags that modify the behavior of
+a source:
+
+'nosync'::
+ Skip this source when *port sync* or *port selfupdate* are used. You can use
+ this flag to avoid updating your local ports tree managed by a source
+ control system such as Git or Subversion. You are responsible for generating
+ a current port index using the man:portindex[1] command for sources marked
+ with this flag.
+
+'default'::
+ Mark this source as the default. The default source is used as a fallback to
+ load additional files (such as PortGroups and mirror definitions) from the
+ '_resources/port1.0' directory.
+
+FILES
+-----
+The path of the 'sources.conf' file is specified in the *sources_conf* option of
+man:macports.conf[5]. It defaults to '$\{prefix\}/etc/macports/sources.conf'.
+There is no user-specific 'sources.conf' file, but support for this can be
+emulated by setting 'sources.conf' in the user-specific man:macports.conf[5]
+file.
+
+SEE ALSO
+--------
+man:port[1], man:port-selfupdate[1], man:port-sync[1], man:portindex[1],
+man:macports.conf[5]
+
+AUTHORS
+-------
+ (C) 2015 The MacPorts Project
+ Clemens Lang <cal@macports.org>
</ins></span></pre>
</div>
</div>
</body>
</html>