* setup-net.sgml: Improve setup.exe documentation

This commit is contained in:
Joshua Daniel Franklin 2003-03-23 16:23:52 +00:00
parent b2ee9a5565
commit 489d990b9d
2 changed files with 36 additions and 21 deletions

View File

@ -1,3 +1,7 @@
2003-03-23 Joshua Daniel Franklin <joshuadfranklin@yahoo.com>
* setup-net.sgml: Improve setup.exe documentation
2003-03-22 Joshua Daniel Franklin <joshuadfranklin@yahoo.com> 2003-03-22 Joshua Daniel Franklin <joshuadfranklin@yahoo.com>
* setup-net.sgml: Document setup.exe * setup-net.sgml: Document setup.exe

View File

@ -65,11 +65,16 @@ determine access to installed files.
The <literal>Install For</literal> options of The <literal>Install For</literal> options of
<literal>All Users</literal> or <literal>All Users</literal> or
<literal>Just Me</literal> are especially for multiuser systems <literal>Just Me</literal> are especially for multiuser systems
or Domain users. If you have a single-user workstation, this or Domain users. If you have access to a user account that is a local
option probably does not concern you. If you are seeking to rollout Administrator or a member of the Administrators group, it is best to
Cygwin on a large Domain, you will want to see <Xref Linkend="ntsec"> install for <literal>All Users</literal>. You should only install for
in the Cygwin User's Guide and possibly consult the Cygwin <literal>Just Me</literal> if you do not have write access to
mailing list archives about others' experiences. <literal>HKEY_LOCAL_MACHINE</literal> in the registry or the
All Users Start Menu, even if you are the only user planning to use
Cygwin on the machine. If you are seeking to rollout
Cygwin on a large Domain, you will want to read <Xref Linkend="ntsec">
in the Cygwin User's Guide and consult the Cygwin mailing list archives
about others' experiences.
</para> </para>
<para> <para>
The <literal>Default Text File Type</literal> should be left on The <literal>Default Text File Type</literal> should be left on
@ -83,7 +88,7 @@ have a very good reason to switch it to
<para> <para>
The <literal>Local Package Directory</literal> is the cache where The <literal>Local Package Directory</literal> is the cache where
<command>setup.exe</command> stores the packages before they are <command>setup.exe</command> stores the packages before they are
installed. The cache should not be the same folder as the Cygwin installed. The cache must not be the same folder as the Cygwin
root. Within the cache, a separate directory is created for each root. Within the cache, a separate directory is created for each
Cygwin mirror, which allows <command>setup.exe</command> to use Cygwin mirror, which allows <command>setup.exe</command> to use
multiple mirrors and custom packages. After installing Cygwin, multiple mirrors and custom packages. After installing Cygwin,
@ -94,10 +99,11 @@ or in case you need to reinstall a package.
<sect2><title>Connection Method</title> <sect2><title>Connection Method</title>
<para> <para>
For most users, the <literal>Direct Connection</literal> method The <literal>Direct Connection</literal> method of downloading will
of downloading is the best choice. If you have a proxy server, directly download the packages, while the IE5 method will leverage your
you can use the <literal>Use IE5 Settings</literal> if it is IE5 cache for performance. If your organisation uses a proxy server or
already set up in Internet Exlporer, or manually type it into auto-configuration scripts, the IE5 method also uses these settings.
If you have a proxy server, you can manually type it into
the <literal>Use Proxy</literal> section. Unfortunately, the <literal>Use Proxy</literal> section. Unfortunately,
<command>setup.exe</command> does not currently support password <command>setup.exe</command> does not currently support password
authorization for proxy servers. authorization for proxy servers.
@ -120,16 +126,21 @@ mirror) you can add it.
<sect2><title>Choosing Packages</title> <sect2><title>Choosing Packages</title>
<para> <para>
For each selected mirror site, <command>setup.exe</command> downloads a For each selected mirror site, <command>setup.exe</command> downloads a
small text file called <literal>setup.ini</literal> that contains a list small text file called <literal>setup.bz2</literal> that contains a list
of packages available from that site along with some basic information about of packages available from that site along with some basic information about
each package (version number, dependencies, checksum, etc.) which each package which <command>setup.exe</command> parses and uses to create the
<command>setup.exe</command> parses and uses to create the chooser window. chooser window. For details about the format of this file, see
<ulink URL="http://sources.redhat.com/cygwin-apps/setup.html#setup.ini">
http://sources.redhat.com/cygwin-apps/setup.html</ulink>.
</para> </para>
<para> <para>
The chooser is the most complex part of <command>setup.exe</command>. The chooser is the most complex part of <command>setup.exe</command>.
Packages are divided into categories. By default <command>setup.exe</command> Packages are grouped into categories, and one package may belong to multiple
categories (assigned by the volunteer package maintainer). Each package
can be found under any of those categories in the heirarchial chooser view.
By default <command>setup.exe</command>
will install only the packages in the <literal>Base</literal> category will install only the packages in the <literal>Base</literal> category
and their dependencies, resulting in a very basic Cygwin installation. and their dependencies, resulting in a minimal Cygwin installation.
However, this will not include many commonly used tools such as However, this will not include many commonly used tools such as
<command>gcc</command> (which you will find in the <literal>Devel</literal> <command>gcc</command> (which you will find in the <literal>Devel</literal>
category). category).
@ -197,13 +208,13 @@ use these shortcuts as a guide to creating your own.
Last of all, <command>setup.exe</command> will run any post-install Last of all, <command>setup.exe</command> will run any post-install
scripts to finish correctly setting up installed packages. Since each scripts to finish correctly setting up installed packages. Since each
script is run separately, several windows may pop up. If you are script is run separately, several windows may pop up. If you are
interested in what is being done, the scripts are kept in the interested in what is being done, see the Cygwin Package Contributor's
<literal>/etc/postinstall/</literal> directory, renamed with a Guide at <ulink
<literal>done</literal> extension after being run. When the last URL="http://cygwin.com/setup.html">http://cygwin.com/setup.html</ulink>
post-install script is completed, <command>setup.exe</command> will When the last post-install script is completed, <command>setup.exe</command>
display a box announcing the completion. A few packages, such as will display a box announcing the completion. A few packages, such as
the OpenSSH server, require some manual site-specific configuration. the OpenSSH server, require some manual site-specific configuration.
Relevant documentation can be found in the <literal>/usr/doc/Cygwin</literal> Relevant documentation can be found in the <literal>/usr/doc/Cygwin/</literal>
directory. directory.
</para> </para>
</sect2> </sect2>