From 489d990b9d77e63c52ae8947fddc57591e172789 Mon Sep 17 00:00:00 2001 From: Joshua Daniel Franklin Date: Sun, 23 Mar 2003 16:23:52 +0000 Subject: [PATCH] * setup-net.sgml: Improve setup.exe documentation --- winsup/doc/ChangeLog | 4 +++ winsup/doc/setup-net.sgml | 53 +++++++++++++++++++++++---------------- 2 files changed, 36 insertions(+), 21 deletions(-) diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index e904ce8dd..f32a6fd40 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-03-23 Joshua Daniel Franklin + + * setup-net.sgml: Improve setup.exe documentation + 2003-03-22 Joshua Daniel Franklin * setup-net.sgml: Document setup.exe diff --git a/winsup/doc/setup-net.sgml b/winsup/doc/setup-net.sgml index 9d57e0c35..c1c2b1b6a 100644 --- a/winsup/doc/setup-net.sgml +++ b/winsup/doc/setup-net.sgml @@ -65,11 +65,16 @@ determine access to installed files. The Install For options of All Users or Just Me are especially for multiuser systems -or Domain users. If you have a single-user workstation, this -option probably does not concern you. If you are seeking to rollout -Cygwin on a large Domain, you will want to see -in the Cygwin User's Guide and possibly consult the Cygwin -mailing list archives about others' experiences. +or Domain users. If you have access to a user account that is a local +Administrator or a member of the Administrators group, it is best to +install for All Users. You should only install for +Just Me if you do not have write access to +HKEY_LOCAL_MACHINE 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 +in the Cygwin User's Guide and consult the Cygwin mailing list archives +about others' experiences. The Default Text File Type should be left on @@ -83,7 +88,7 @@ have a very good reason to switch it to The Local Package Directory is the cache where setup.exe 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 Cygwin mirror, which allows setup.exe to use multiple mirrors and custom packages. After installing Cygwin, @@ -94,10 +99,11 @@ or in case you need to reinstall a package. Connection Method -For most users, the Direct Connection method -of downloading is the best choice. If you have a proxy server, -you can use the Use IE5 Settings if it is -already set up in Internet Exlporer, or manually type it into +The Direct Connection method of downloading will +directly download the packages, while the IE5 method will leverage your +IE5 cache for performance. If your organisation uses a proxy server or +auto-configuration scripts, the IE5 method also uses these settings. +If you have a proxy server, you can manually type it into the Use Proxy section. Unfortunately, setup.exe does not currently support password authorization for proxy servers. @@ -120,16 +126,21 @@ mirror) you can add it. Choosing Packages For each selected mirror site, setup.exe downloads a -small text file called setup.ini that contains a list +small text file called setup.bz2 that contains a list of packages available from that site along with some basic information about -each package (version number, dependencies, checksum, etc.) which -setup.exe parses and uses to create the chooser window. +each package which setup.exe parses and uses to create the +chooser window. For details about the format of this file, see + +http://sources.redhat.com/cygwin-apps/setup.html. The chooser is the most complex part of setup.exe. -Packages are divided into categories. By default setup.exe +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 setup.exe will install only the packages in the Base 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 gcc (which you will find in the Devel category). @@ -197,13 +208,13 @@ use these shortcuts as a guide to creating your own. Last of all, setup.exe will run any post-install scripts to finish correctly setting up installed packages. Since each script is run separately, several windows may pop up. If you are -interested in what is being done, the scripts are kept in the -/etc/postinstall/ directory, renamed with a -done extension after being run. When the last -post-install script is completed, setup.exe will -display a box announcing the completion. A few packages, such as +interested in what is being done, see the Cygwin Package Contributor's +Guide at http://cygwin.com/setup.html +When the last post-install script is completed, setup.exe +will display a box announcing the completion. A few packages, such as the OpenSSH server, require some manual site-specific configuration. -Relevant documentation can be found in the /usr/doc/Cygwin +Relevant documentation can be found in the /usr/doc/Cygwin/ directory.