This is the mail archive of the
cygwin-apps-cvs
mailing list for the cygwin-apps project.
[cygwin-apps htdocs - The cygwin-apps website files] branch master, updated. 358f84c7657d9b3a5e5c8915619612fcf36e1701
- From: jturney at sourceware dot org
- To: cygwin-apps-cvs at sourceware dot org
- Date: 13 Dec 2016 21:09:20 -0000
- Subject: [cygwin-apps htdocs - The cygwin-apps website files] branch master, updated. 358f84c7657d9b3a5e5c8915619612fcf36e1701
https://sourceware.org/git/gitweb.cgi?p=cygwin-apps/apps-htdocs.git;h=358f84c7657d9b3a5e5c8915619612fcf36e1701
commit 358f84c7657d9b3a5e5c8915619612fcf36e1701
Author: Jon Turney <jon.turney@dronecode.org.uk>
Date: Tue Dec 13 21:06:50 2016 +0000
Remove link to xemacs.org
Link is broken as xemacs.org is dead. It seems this statement wasn't true
for some time, anyhow.
https://sourceware.org/git/gitweb.cgi?p=cygwin-apps/apps-htdocs.git;h=ded271b7348ba0cc19d2e93165d8e0f37112c6ee
commit ded271b7348ba0cc19d2e93165d8e0f37112c6ee
Author: Jon Turney <jon.turney@dronecode.org.uk>
Date: Tue Dec 13 21:03:48 2016 +0000
Update setup.ini documentation
Diff:
---
setup-head.ini.html | 203 +++++++++++++++++++++++++++++++--------------------
setup.html | 9 +--
2 files changed, 125 insertions(+), 87 deletions(-)
diff --git a/setup-head.ini.html b/setup-head.ini.html
index 2ecfc87..515203f 100644
--- a/setup-head.ini.html
+++ b/setup-head.ini.html
@@ -4,54 +4,71 @@
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<link href="cygwin-apps.css" title="cygwin-apps" media="screen" type="text/css" rel="stylesheet" />
-<title>The Cygwin-Apps setup.ini documentation for git master</title>
+<title>setup.ini documentation</title>
</head>
<body>
<div id="header">
-<h1>setup.ini</h1>
+<h1>setup.ini documentation</h1>
</div>
<div id="main">
<p>Note that <tt>setup.ini</tt> is automatically generated for the Cygwin
site. This section is intended as a reference for writing software that
-interoperates with the setup.ini package listing, or who are using a fork of
-setup elsewhere and want to know what they can achieve with it. It is not
-aimed at setup.exe end users or Cygwin package maintainers - although you may
+interoperates with the <tt>setup.ini</tt> package listing, or who are using a
+fork of setup elsewhere and want to know what they can achieve with it. It is
+not aimed at setup end users or Cygwin package maintainers - although you may
find it of interest.</p>
-<p><tt>setup.exe</tt> reads a file called <tt>setup.ini</tt> that resides on
-all Cygwin mirrors. The format is quite flexible - it's grown over time. The
-content of the file drives setup.exe's behaviour. It lists the packages
+<p>setup reads a (possibly compressed) file called <tt>setup.ini</tt> that
+resides on all Cygwin mirrors. The format is quite flexible - it's grown over
+time. The content of the file drives setup's behaviour. It lists the packages
available from a given mirror site (the one it is downloaded from), and what
-source files each package needs, available versions, dependencies and the
+source files each package has, available versions, dependencies and the
like.</p>
-<p>There are two optional global parameters in this file, followed by a list
-of packages. The <tt>#</tt> character is ignored by setup and can
-be used to add commentary to the file. Anything after this character is ignored.</p>
+<p>A <tt>setup.ini</tt> file consists of optional header lines, followed by a
+sequence of package sections.</p>
+
+<p>Lines that begin with the <tt>#</tt> character are ignored by setup, and can
+be used to add commentary to the file.</p>
+
+<h3>Headers</h3>
+
+<p>
+Header lines can only appear at the beginning of <tt>setup.ini</tt> files,
+before the first package section.
+</p>
<p><tt>setup-timestamp: <i>number</i></tt></p>
-<p>This entry can only appear at the beginning of setup.ini files. It
-indicates the time that the setup.ini file was created. Its purpose is to
-warn the user when the timestamp is <em>less</em> than the last setup.ini
-used; i.e. it prevents accidental regression. Use "perl -e 'print time'" to
-get a timestamp.</p>
-
-<p><tt>setup-version: <i>number</i></tt></p>
-<p>This entry can only appear at the beginning of setup.ini files. It
-indicates the version number of the setup.exe for which this setup.ini was
-generated. <tt>setup.exe</tt> will warn if the version number of setup is less
-than the version number in a setup.ini file. In the future this will get
-decoupled from the setup.ini version, and be coupled to the parser logic, to
-allow older versions of setup that can operate correctly on a setup.ini file
-to do so without warnings.</p>
+<p>
+The time (in Unix epoch seconds) that the <tt>setup.ini</tt> file was
+created. Its purpose is to warn the user when the timestamp is <em>less</em>
+than the last <tt>setup.ini</tt> used; i.e. it prevents accidental
+regression.</p>
+
+<p><tt>setup-version: <i>version</i></tt></p>
+<p>
+The version of setup for which this <tt>setup.ini</tt> was generated. Setup will
+warn if the version of setup is less than the version in a <tt>setup.ini</tt>
+file. In the future this may get decoupled from the <tt>setup.ini</tt> version,
+and be coupled to the parser logic, to allow older versions of setup that can
+operate correctly on a <tt>setup.ini</tt> file to do so without warnings.</p>
+
+<p><tt>release: text</tt><p>
+<p>A label for the package set. The label <tt>cygwin</tt> is reserved for use
+by Cygwin.</p>
+
+<p><tt>arch: x86|x86_64</tt><p>
+<p>The processor architecture this package set is built for.</p>
+
+<h3>Packages</h3>
<p><tt>@ <i>package</i></tt></p>
<p><tt>Package: <i>package</i></tt></p>
-<p>Lines beginning with the "at" symbol or "Package:" indicate the start of
-a package section. Each package consists of a name, one or more descriptive
-texts, package categories, and up to three version definitions.</p>
+<p>Lines beginning with the "at" symbol or "Package:" indicate the start of a
+package section. Each package section consists of a name, descriptive texts,
+package categories, and one or more package version descriptions.</p>
<p><tt>sdesc: <i>"some text"</i></tt></p>
<p>This is the "short description" of the package. This text, if available,
@@ -66,86 +83,112 @@ used as a supplemental description of the package.</p>
<p>The category or Section line indicates the categories that this package
belongs to. One package can belong to multiple categories. Multiple categories
are separated by spaces. See the description of categories in <a
- href='http://www.cygwin.com/setup.html#setup.hint'>setup.hint</a> for more
+ href="https://www.cygwin.com/packaging-hint-files.html#categories";>.hint files</a> for more
information on categories.</p>
-<p><tt>[curr]<br/>[prev]<br/>[test]</tt></p>
-<p>These indicate the start of a version description within a package. Note
-that <tt>[curr]</tt> is the default and may be omitted if that version happens
-to be specified before the others. "Curr" indicates the current stable
-(preferred) version, "prev" is the previous stable version, and "test"
-indicates a test or experimental version.</p>
+<p><tt>message: <i>id</i> <i>"some text"</i></tt></p>
+<p>Optional. This is text that will be displayed by setup when the package is
+installed.</p>
+
+<p>
+ <tt>
+ [curr]<br/>
+ [prev]<br/>
+ [test]<br/>
+ [ver<digits>]</tt>
+</p>
+<p>These indicate the start of a version description within a package
+section. Note that <tt>[curr]</tt> is the default, and may be omitted if that
+version happens to be specified before the others. "curr" indicates the current
+stable (preferred) version, and "test" indicates a test
+version. "ver<digits>" carries no meaning except to be a unique label for
+a version. For historical reasons, "prev" is used for the version preceding the
+"curr" version.
+</p>
<p><tt>requires: <i>package[ package...]</i></tt></p>
<p>Indicates a list of packages that this package needs at runtime in order
to function correctly. Multiple packages should be separated by a space.</p>
<p><tt>version: <i>version</i></tt></p>
-<p>Indicates the version of the package. This is currently derived from the <a
- href="#naming">name of the package</a>.</p>
-
-<p><tt>install: <i>filename</i> <i>size-in-bytes</i> <i>MD5 sum</i></tt></p>
-<p>Indicates the file to install for that version, and its size in bytes. The
-file name must include the full path (relative to setup.ini's directory), and
-the file size must match the actual file size (setup uses this to verify it
-got the whole file). The optional MD5 sum is 32 characters from the set 0-9a-f
-(case matters). If it does not match the locally calculated md5 sum, the
-package is considered corrupt and won't be installed from by setup.exe.</p>
-
-<p><tt>source: <i>filename</i> <i>size-in-bytes</i> <i>MD5 sum</i></tt></p>
-<p>(Deprecated) Like the file to install, this is the corresponding
-sources.</p>
+<p>Indicates the version of the package.</p>
+
+<p><tt>install: <i>filename</i> <i>size-in-bytes</i> <i>hash</i></tt></p>
+<p>Indicates the archive file to install for that version, and its size in
+bytes, and a checksum. The file name must include the path (relative to the base
+directory), and the file size must match the actual file size (setup uses this
+to verify it got the whole file). The hash is a SHA512 hash encoded as 128 hex
+characters, or 86 base64 characters, or an MD5 hash encoded as 32 hex
+characters. If it does not match the locally calculated hash, the package is
+considered corrupt and won't be installed by setup. Hex characters are 0-9a-f
+(case matters).</p>
+
+<p><tt>source: <i>filename</i> <i>size-in-bytes</i> <i>hash</i></tt></p>
+<p>Like <tt>install:</tt>, for the corresponding archive file to install the
+source.</p>
<h3>Note: The following directives are not fully implemented yet.</h3>
-<p><tt>Depends: <i>package [(<< | >> | <=; | >= | < |
+<p><tt>Depends: <i>package [(<< | >> | <= | >= | < |
> version-identifier)][, package ...]</i></tt></p>
-<p>This is a more sophisticated version of the 'requires' keyword, allowing
-the specification of explicit version number relationships. Packages
+<p>This is a more sophisticated version of the <tt>requires:</tt> keyword,
+allowing the specification of explicit version number relationships. Packages
are separated by commas instead of spaces, and this entry can span multiple
lines.</p>
-<p><tt>Source: <i>package [(<< | >> | <=; | >= | < | >
+<p><tt>Source: <i>package [(<< | >> | <= | >= | < | >
version-identifier)]</i></tt></p>
-<p>Indicates the source-package that should be used when downloading the
-source for the current package version. I.e. for package foo-dev, one might
-have "Source: foo" to indicate that the source package for foo-dev is foo.
+<p>Indicates the source-package that should be used when downloading the source
+for the current package version. i.e. for package foo-dev, one might have
+"Source: foo-src" to indicate that the source package for foo-dev is foo-src.
This entry should not be used in conjunction with the "source:" entry.</p>
-<p><tt>Build-Depends: <i>package [(<< | >> | <=; | >= | <
+<p><tt>Build-Depends: <i>package [(<< | >> | <= | >= | <
| > version-identifier)] | [ package ...] [,package ...]</i></tt></p>
<p>Indicates the binary packages required to build the current source
package.</p>
<h3>An example</h3>
<pre>
-setup-timestamp: 967844652
+# an example setup.ini
+release: cygwin
+arch: x86
+setup-timestamp: 1481478212
+setup-version: 2.876
@ cygwin
-sdesc: "Cygwin Runtime"
-ldesc: "A Posix runtime emulator for Windows platforms"
-version: 1.1.4
-install: release/cygwin/cygwin-1.1.4.tar.bz2 1234567
-source: release/cygwin/cygwin-1.1.4.tar.bz2 1341245
+sdesc: "The UNIX emulation engine"
+ldesc: "The UNIX emulation engine"
+category: Base
+requires: base-cygwin
+version: 2.6.0-1
+install: x86/release/cygwin/cygwin-2.6.0-1.tar.xz 1945744 d0ee36febabde34ded4bcbe77f00a6367ab4293b3f24989044335685b294dd42f64e2d0d8956f0651c8d26c583897b1dc16b6c0a023d859ba5ce97eed19624fc
+source: x86/release/cygwin/cygwin-2.6.0-1-src.tar.xz 12900708 1660ecefbc36e6825cff333b0bbd4dae2b891e041aafa8587ba7f61d7945a23c4189ac4776d975fc36dbe8fd6b922f7e1963661ad8d1ce49a237ca030f7b69d0
[prev]
-version: 1.1.3
-install: release/cygwin/cygwin-1.1.3.tar.bz2 1234580
-source: release/cygwin/cygwin-1.1.3.tar.bz2 1341123
-
-@ bash
+version: 2.5.2-1
+install: x86/release/cygwin/cygwin-2.5.2-1.tar.xz 2829972 bfde5e7737bb32fb8642566ff82cb5c86899b10f2dbad3bcd0ff2ea11c4b8b0292e52597bbc3d6e1fea7899a1f1a1c32f23f6807aaffd776ed9519e1631ff9aa
+source: x86/release/cygwin/cygwin-2.5.2-1-src.tar.xz 13003452 ae559cc50673f5da95e6d33818665414b9ce50211900e4d02e9a303f594afb5e746e82b457e48495dea0fa6c05c07f6d44cd900c98efb670d5c6c741511c8b0f
[test]
-version: 20000901
-install: release/bash/bash-20000901.tar.bz2 276403
-source: release/bash/bash-20000901-src.tar.bz2 1892899
-[curr]
-version: 2.04
-install: release/bash/bash-2.04.tar.bz2 277375
-source: release/bash/bash-2.04-src.tar.bz2 1815177
-# We need either the current released gcc, or a known good version of gcc
-# And various anciliary tools
-Build-Depends: gcc (= 2.95.3-5) | gcc (>> 3.1.1-1) | gcc2, binutils,
-make, automake, autoconf
+version: 2.6.1-0.1
+install: x86/release/cygwin/cygwin-2.6.1-0.1.tar.xz 1946980 34d161ee790cb5b03b9d7057cb03473c56c135623416ed980fd94d049fa2df268ab5dfb72e11dabfd9f4c60aaf7daa26a88c566daf05558d5508a0bacd2f0b43
+source: x86/release/cygwin/cygwin-2.6.1-0.1-src.tar.xz 12908060 c7fed48626f3411dca8bc2c65f3a35822eee1c661b514af803f7acb7b9283a5b0212eeb78e72601bd5525c41bafefde5f258d93331bd98c625a82e75434894f2
+@ bash
+sdesc: "The GNU Bourne Again SHell"
+ldesc: "Bash is an sh-compatible shell that incorporates useful features
+from the Korn shell (ksh) and C shell (csh). It is intended to conform to the
+IEEE POSIX P1003.2/ISO 9945.2 Shell and Tools standard. It offers functional
+improvements over sh for both programming and interactive use. In addition,
+most sh scripts can be run by Bash without modification."
+category: Base Shells
+requires: coreutils cygwin libgcc1 libiconv2 libintl8 libncursesw10 libreadline7
+version: 4.3.48-8
+install: x86/release/bash/bash-4.3.48-8.tar.xz 1413684 937dd36982aba5a373534dd605803855bb86252e9e010ad62ba83ae653627584c55673e4aba9d3c7c8f1106b56ff0b7b5af599a1f72568a01885e33b6d9f62e5
+source: x86/release/bash/bash-4.3.48-8-src.tar.xz 7995684 cd13b3a21abbd552a66f194a85c2a6094b90c92bed3558b7447be06a8e47ad9e673c424bfbbebfcc004d5b46b47fe47a54413e99894ff89989e176fb9e3ed419
+[prev]
+version: 4.3.46-7
+install: x86/release/bash/bash-4.3.46-7.tar.xz 1413640 2029f253ee794f8dfb2fa4cf6f9212307281c8e7a61b621755bc0b2d415ae92b8d60c801b22438dd70f5e4d98bf1b409622271308cc3a3f26dbb19f443dfdb77
+source: x86/release/bash/bash-4.3.46-7-src.tar.xz 7994960 a216448a2700627656b0d53eca93a94f0d97859d5c24d53d7e4bad71883ff7bcf9346d027453f71eabc4df6099b5df1d3f068b06a8b36a796d1943931b759422
</pre>
</div>
diff --git a/setup.html b/setup.html
index 3175d4a..3e1e660 100644
--- a/setup.html
+++ b/setup.html
@@ -12,14 +12,9 @@
</div>
<div id="main">
-<p>This page is a reference for Cygwin's <tt>setup</tt> project, which
+<p>This page is a reference for Cygwin's <tt>setup</tt> project, which
is a tool for installing Cygwin over the internet, or from a local directory.
-Cygwin's <tt>setup</tt> has been forked for use on other projects -
-including the <a
-href="http://www.xemacs.org/Download/win32/netinstaller.html";>XEmacs Net
-Installer</a>. We're always keen to hear of anyone else using the code, so
-please, let us know on the Cygwin-apps <a
-href="http://www.cygwin.com/lists.html#cygwin-apps";>mailing list</a>.</p>
+</p>
<p>
If you want information on how to use <tt>setup</tt> to install Cygwin,