diff --git a/winsup/doc/faq-setup.xml b/winsup/doc/faq-setup.xml
index b242fbae4..c04ffe9a5 100644
--- a/winsup/doc/faq-setup.xml
+++ b/winsup/doc/faq-setup.xml
@@ -10,12 +10,16 @@
What is the recommended installation procedure?
-There is only one recommended way to install Cygwin, which is to use the GUI
-installer setup-*.exe. It is flexible and easy to use.
+
+There is only one recommended way to install Cygwin, which is to use the
+Cygwin Setup program, a GUI installer named
+setup-x86_64.exe for 64 bit Windows, or
+setup-x86.exe for 32 bit Windows. It is flexible and easy to use.
You can pick and choose the packages you wish to install, and update
them individually. Full source code is available for all packages and
-tools. More information on using Cygwin Setup may be found at
-.
+tools.
+More information
+is available on using the Cygwin Setup program.
If you do it any other way, you're on your own!
If something doesn't work right for you, and
@@ -35,8 +39,8 @@ see .
The Cygwin Setup program is designed to be interactive, but there are
a few different ways to automate it. If you are deploying to multiple systems,
the best way is to run through a full installation once, saving the entire
-downloaded package tree. Then, on target systems, run Cygwin Setup as a
-"Local Install" pointed at your downloaded package tree. You could do this
+downloaded package tree. Then, on target systems, run the Cygwin Setup program as a
+"Local Install" pointed at your downloaded package tree. You could do this
non-interactively with the command line options
-q -L -l x:\cygwin-local\, where your downloaded
package tree is in x:\cygwin-local\ (see the next FAQ for
@@ -50,32 +54,33 @@ For other options, search the mailing lists with terms such as
-Does Setup accept command-line arguments?
+Does the Cygwin Setup program accept command-line arguments?
-Yes, run setup-x86.exe --help or
-setup-x86_64.exe --help for a list.
+Yes, run the Cygwin Setup program with option
+--help for an up to date list:
--allow-unsupported-windows Allow old, unsupported Windows versions
- -a --arch architecture to install (x86_64 or x86)
+ -a --arch Architecture to install (x86_64 or x86)
-C --categories Specify entire categories to install
- -o --delete-orphans remove orphaned packages
+ -o --delete-orphans Remove orphaned packages
-A --disable-buggy-antivirus Disable known or suspected buggy anti virus
software packages during execution.
- -D --download Download from internet
- -f --force-current select the current version for all packages
- -h --help print help
- -I --include-source Automatically include source download
+ -D --download Download packages from internet only
+ -f --force-current Select the current version for all packages
+ -h --help Print help
+ -I --include-source Automatically install source for every
+ package installed
-i --ini-basename Use a different basename, e.g. "foo",
instead of "setup"
-U --keep-untrusted-keys Use untrusted keys and retain all
- -L --local-install Install from local directory
+ -L --local-install Install packages from local directory only
-l --local-package-dir Local package directory
- -m --mirror-mode Skip availability check when installing from
- local directory (requires local directory to
- be clean mirror!)
+ -m --mirror-mode Skip package availability check when
+ installing from local directory (requires
+ local directory to be clean mirror!)
-B --no-admin Do not check for and enforce running as
Administrator
-d --no-desktop Disable creation of desktop shortcut
@@ -85,23 +90,29 @@ For other options, search the mailing lists with terms such as
shortcuts
-N --no-startmenu Disable creation of start menu shortcut
-X --no-verify Don't verify setup.ini signatures
- -O --only-site Ignore all sites except for -s
+ --no-version-check Suppress checking if a newer version of
+ setup is available
+ --old-keys Enable old cygwin.com keys
+ -O --only-site Do not download mirror list. Only use sites
+ specified with -s.
-M --package-manager Semi-attended chooser-only mode
-P --packages Specify packages to install
-p --proxy HTTP/FTP proxy (host:port)
- -Y --prune-install prune the installation to only the requested
+ -Y --prune-install Prune the installation to only the requested
packages
- -K --pubkey URL of extra public key file (gpg format)
+ -K --pubkey URL or absolute path of extra public key
+ file (RFC4880 format)
-q --quiet-mode Unattended setup mode
-c --remove-categories Specify categories to uninstall
-x --remove-packages Specify packages to uninstall
-R --root Root installation directory
- -S --sexpr-pubkey Extra public key in s-expr format
- -s --site Download site
- -u --untrusted-keys Use untrusted keys from last-extrakeys
- -g --upgrade-also also upgrade installed packages
+ -S --sexpr-pubkey Extra DSA public key in s-expr format
+ -s --site Download site URL
+ -u --untrusted-keys Use untrusted saved extra keys
+ -g --upgrade-also Also upgrade installed packages
--user-agent User agent string for HTTP requests
-v --verbose Verbose output
+ -V --version Show version
-W --wait When elevating, wait for elevated child
process
@@ -116,15 +127,14 @@ For other options, search the mailing lists with terms such as
this allows to set up the Cygwin environment so that all users can start
a Cygwin shell out of the box. However, if you don't have administrator
rights for your machine, and the admins don't want to install it for you,
-you can install Cygwin just for yourself by downloading
-setup-x86.exe (for a 32 bit install) or
-setup-x86_64.exe (for a 64 bit install) and then start
+you can install Cygwin just for yourself by downloading the Cygwin Setup
+program, and then start
it from the command line or via the "Run..." dialog from the start menu
using the --no-admin option, for instance:
- setup-x86.exe --no-admin
+ setup-x86_64.exe --no-admin
@@ -151,11 +161,11 @@ now.)
-Can I use Cygwin Setup to get old versions of packages (like gcc-2.95)?
+Can I use the Cygwin Setup program to get old versions of packages (like gcc-2.95)?
-Cygwin Setup can be used to install any packages that are on a
-Cygwin mirror, which usually includes one version previous to the
+The Cygwin Setup program can be used to install any packages that are on a
+Cygwin mirror, which usually includes at least one version previous to the
current one. The complete list may be searched at
. There is no complete archive of
older packages. If you have a problem with the current version of
@@ -180,12 +190,12 @@ Here is how Cygwin secures the installation and update process to counter
-The Cygwin website provides the setup program
+The Cygwin website provides the Cygwin Setup program
(setup-x86.exe or setup-x86_64.exe)
using HTTPS (SSL/TLS).
-This authenticates that the setup program
+This authenticates that the Cygwin Setup program
came from the Cygwin website
-(users simply use their web browsers to download the setup program).
+(users simply use their web browsers to download the Cygwin Setup program).
You can use tools like Qualsys' SSL Server Test,
,
to check the HTTPS configuration of Cygwin.
@@ -193,31 +203,32 @@ The cygwin.com site supports HTTP Strict Transport Security (HSTS),
which forces the browser to keep using HTTPS once the browser has seen
it before (this counters many downgrade attacks).
-The setup program has the
+The Cygwin Setup program has the
Cygwin public key embedded in it.
The Cygwin public key is protected from attacker subversion
during transmission by the previous step, and this public
key is then used to protect all later steps.
-You can confirm that the key is in setup by looking at the setup project
+You can confirm that the key is in the Cygwin Setup program by looking at the setup project
()
source code file cyg-pubkey.h
(the key is automatically generated from file cygwin.pub).
-The setup program downloads
+The Cygwin Setup program downloads
the package list setup.ini from a mirror
and checks its digital signature.
-The package list is in the file
+The package list is in the files
+setup.xz, setup.zst,
setup.bz2 (compressed) or
setup.ini (uncompressed) on the selected mirror.
The package list includes for every official Cygwin package
the package name, cryptographic hash, and length (in bytes).
-The setup program also gets the relevant .sig
+The Cygwin Setup program also gets the relevant .sig
(signature) file for that package list, and checks that the package list
-is properly signed with the Cygwin public key embedded in the setup program.
+is properly signed with the Cygwin public key embedded in the Setup program.
A mirror could corrupt the package list and/or signature, but this
-would be detected by setup program's signature detection
+would be detected by the Cygwin Setup program's signature detection
(unless you use the -X option to disable signature checking).
-The setup program also checks the package list
+The Cygwin Setup program also checks the package list
timestamp/version and reports to the user if the file
goes backwards in time; that process detects downgrade attacks
(e.g., where an attacker subverts a mirror to send a signed package list
@@ -226,7 +237,7 @@ that is older than the currently-downloaded version).
The packages to be installed
(which may be updates) are downloaded and both their
lengths and cryptographic hashes
-(from the signed setup.{bz2,ini} file) are checked.
+(from the signed setup.xz/.zst/.bz2/.ini file) are checked.
Non-matching packages are rejected, countering any attacker's
attempt to subvert the files on a mirror.
Cygwin currently uses the cryptographic hash function SHA-512
@@ -250,8 +261,8 @@ widely-used SHA-2 suite of cryptographic hashes).
To best secure your installation and update process, download
-the setup program setup-x86.exe (32-bit) or
-setup-x86_64.exe (64-bit), and then
+the Cygwin Setup program setup-x86_64.exe (64-bit) or
+setup-x86.exe (32-bit), and then
check its signature (using a signature-checking tool you trust)
using the Cygwin public key
().
@@ -277,22 +288,22 @@ Not everyone will go through this additional effort,
but we make it possible for those who want that extra confidence.
We also provide automatic mechanisms
(such as our use of HTTPS) for those with limited time and
-do not want to perform the signature checking on the setup program itself.
-Once the correct setup program is running, it will counter other attacks
+do not want to perform the signature checking on the Cygwin Setup program itself.
+Once the correct Setup program is running, it will counter other attacks
as described in
.
-Is Cygwin Setup, or one of the packages, infected with a virus?
+Is the Cygwin Setup program, or one of the packages, infected with a virus?
Unlikely. Unless you can confirm it, please don't report it to the
mailing list. Anti-virus products have been known to detect false
positives when extracting compressed tar archives. If this causes
problems for you, consider disabling your anti-virus software when
-running setup. Read the next entry for a fairly safe way to do
+running the Cygwin Setup program. Read the next entry for a fairly safe way to do
this.
@@ -304,17 +315,18 @@ this.
Both Network Associates (formerly McAfee) and Norton anti-virus
products have been reported to "hang" when extracting Cygwin tar
archives. If this happens to you, consider disabling your anti-virus
-software when running Cygwin Setup. The following procedure should be
+software when running the Cygwin Setup program. The following procedure should be
a fairly safe way to do that:
-Download setup-x86.exe or
-setup-x86_64.exe and scan it explicitly.
+Download setup-x86_64.exe or
+setup-x86.exe and scan it explicitly.
Turn off the anti-virus software.
-Run setup to download and extract all the tar files.
+Run the Cygwin Setup program to download and install or upgrade
+all desired packages.
Re-activate your anti-virus software and scan everything
@@ -324,7 +336,7 @@ disk if you are paranoid.
-This should be safe, but only if Cygwin Setup is not substituted by
+This should be safe, but only if the Cygwin Setup program is not substituted by
something malicious.
See also
@@ -341,7 +353,7 @@ interfere with the normal functioning of Cygwin.
What packages should I download? Where are 'make', 'gcc', 'vi', etc?
-When using Cygwin Setup for the first time, the default is to install
+When using the Cygwin Setup program for the first time, the default is to install
a minimal subset of all available packages. If you want anything beyond that,
you will have to select it explicitly. See
for a searchable list of available
@@ -361,53 +373,20 @@ User's Guide at
Long ago, the default was to install everything, much to the
irritation of most users. Now the default is to install only a basic
-core of packages. Cygwin Setup is designed to make it easy to browse
+core of packages. The Cygwin Setup program is designed to make it easy to browse
categories and select what you want to install or omit from those
-categories. It's also easy to install everything:
+categories.
+There are now more than 10000 Cygwin packages requiring more than 150GB
+of disk space just to download and hundreds of GB more to install so you
+are strongly advised not to attempt to
+install everything
+at once, unless you have a lot of free disk space, a very high speed network
+connection, and the system will not be required for any other purpose for
+many hours (or days) until installation completes.
+For a 32-bit Cygwin installation, you can not install everything, as the
+installation will fail because the 4GB memory available is insufficient to allow
+all the DLLs required to run along with the programs using them.
-
-At the ``Select Packages'' screen, in ``Categories'' view, at the line
-marked ``All'', click on the word ``default'' so that it changes to
-``install''. (Be patient, there is some computing to do at this step.
-It may take a second or two to register the change.) This tells Setup
-to install everything, not just what it thinks you should have
-by default.
-
-
-Now click on the ``View'' button (twice) until you get to the
-``Pending'' view. This shows exactly which packages are about to be
-downloaded and installed.
-
-
-
-
-This procedure only works for packages that are currently available.
-There is no way to tell Cygwin Setup to install all packages by
-default from now on. As new packages become available that would not
-be installed by default, you have to repeat the above procedure to get
-them.
-
-In general, a better method (in my opinion), is to:
-
-
-First download & install all packages that would normally be
-installed by default. This includes fundamental packages and any
-updates to what you have already installed. Then...
-
-
-Run Cygwin Setup again, and apply the above technique to get all
-new packages that would not be installed by default. You can check
-the list in the ``Pending'' view before proceeding, in case there's
-something you really don't want.
-
-
-In the latest version of Cygwin Setup, if you click the ``View''
-button (twice) more, it shows packages not currently installed. You
-ought to check whether you really want to install everything!
-
-
-
-
@@ -415,16 +394,16 @@ ought to check whether you really want to install everythin
That depends, obviously, on what you've chosen to download and
-install. A full installation today is probably larger than 1 GB
+install. A full installation today is many hundreds of GB
installed, not including the package archives themselves nor the source
code.
After installation, the package archives remain in your ``Local
-Package Directory''. By default the location of
-setup-x86{_64}.exe. You may conserve disk space by
+Package Directory''. By default the location of the Cygwin Setup program.
+You may conserve disk space by
deleting the subdirectories there. These directories will have very weird
looking names, being encoded with their URLs
-(named ftp%3a%2f...).
+(named http%3a%2f...cygwin...%2f).
Of course, you can keep them around in case you want to reinstall a
package. If you want to clean out only the outdated packages, Michael Chase
@@ -438,42 +417,42 @@ at unsupported/clean_setup.pl in a Cygwin mirror.
Detailed logs of the most recent Cygwin Setup session can be found in
-/var/log/setup.log.full and less verbose information about
-prior actions is in /var/log/setup.log.
+/var/log/setup.log.full and less verbose information about
+prior actions is in /var/log/setup.log.
-What if setup fails?
+What if the Cygwin Setup program fails?
-First, make sure that you are using the latest version of Cygwin Setup.
+First, make sure that you are using the latest version of the Cygwin Setup program.
The latest version is always available from the Cygwin Home Page at
.
If you are downloading from the Internet, setup will fail if it cannot
-download the list of mirrors at .
+download the list of mirrors at .
It could be that the network is too busy. Something similar could be the
cause of a download site not working. Try another mirror, or try again
later.
-If setup refuses to download a package that you know needs to be
+If the Cygwin Setup program refuses to download a package that you know needs to be
upgraded, try deleting that package's entry from /etc/setup. If you are
reacting quickly to an announcement on the mailing list, it could be
that the mirror you are using doesn't have the latest copy yet. Try
another mirror, or try again tomorrow.
-If setup has otherwise behaved strangely, check the files
-setup.log and setup.log.full in
-/var/log (C:\cygwin\var\log by
+If the Cygwin Setup program has otherwise behaved strangely, check the files
+setup.log and setup.log.full in
+/var/log (C:\cygwin\var\log by
default). It may provide some clues as to what went wrong and why.
If you're still baffled, search the Cygwin mailing list for clues.
Others may have the same problem, and a solution may be posted there.
If that search proves fruitless, send a query to the Cygwin mailing
list. You must provide complete details in your query: version of
-setup, options you selected, contents of setup.log and setup.log.full,
+the Cygwin Setup program, options you selected, contents of setup.log and setup.log.full,
what happened that wasn't supposed to happen, etc.
@@ -542,7 +521,7 @@ getpwnam(3), disregarding HOME.
How do I uninstall individual packages?
-Run Cygwin Setup as you would to install packages. In the list of
+Run the Cygwin Setup program as you would to install packages. In the list of
packages to install, browse the relevant category or click on the
``View'' button to get a full listing. Click on the cycle glyph until
the action reads ``Uninstall''. Proceed by clicking ``Next''.
@@ -627,8 +606,8 @@ mount points as well.
Delete the Cygwin shortcuts on the Desktop and Start Menu, and
-anything left by setup-x86{_64}.exe in the download directory. However, if you
-plan to reinstall Cygwin it's a good idea to keep your setup-x86{_64}.exe
+anything left by the Cygwin Setup program in the download directory. However, if you
+plan to reinstall Cygwin it's a good idea to keep your
download directory since you can reinstall the packages left in its cache
without redownloading them.
@@ -659,7 +638,7 @@ have not been tested. Use them only if there i
bugfix that you need to try, and you are willing to deal with any
problems, or at the request of a Cygwin developer.
-You cannot use Cygwin Setup to install a snapshot.
+You cannot use the Cygwin Setup program to install a snapshot.
First, you will need to download the snapshot from the snapshots
page at . Note the directory where
@@ -699,21 +678,21 @@ DLL, again, close all Cygwin processes, delete
rename C:\cygwin\bin\cygwin1-prev.dll back to
C:\cygwin\bin\cygwin1.dll (again assuming that your "/" is
C:\cygwin). To restore the rest of the snapshot
-files, reinstall the "cygwin" package using Setup.
+files, reinstall the "cygwin" package using the Cygwin Setup program.
-Can Cygwin Setup maintain a ``mirror''?
+Can the Cygwin Setup program maintain a ``mirror''?
-NO. Cygwin Setup cannot do this for you. Use a tool designed for
+NO. The Cygwin Setup program cannot do this for you. Use a tool designed for
this purpose. See ,
for utilities that can do this for you.
For more information on setting up a custom Cygwin package server, see
-the Cygwin Setup homepage at
-.
+the Cygwin Setup program page.
+
diff --git a/winsup/doc/faq-using.xml b/winsup/doc/faq-using.xml
index c24ecf6c5..7b9bbe1c1 100644
--- a/winsup/doc/faq-using.xml
+++ b/winsup/doc/faq-using.xml
@@ -12,10 +12,10 @@
Well, something has gone wrong somehow...
-To repair the damage, you must run Cygwin Setup again, and re-install the
+To repair the damage, you must run the Cygwin Setup program again, and re-install the
package which provides the missing DLL package.
-If you already installed the package at one point, Cygwin Setup won't
+If you already installed the package at one point, the Cygwin Setup program won't
show the option to install the package by default. In the
``Select packages to install'' dialog, click on the Full/Part
button. This lists all packages, even those that are already
@@ -188,7 +188,7 @@ information).
This is done for you in the file /etc/profile, which is sourced by bash
when you start it from the Desktop or Start Menu shortcut, created by
-setup.exe. The line is
+the Cygwin Setup program. The line is
PATH="/usr/local/bin:/usr/bin:/bin:$PATH"
@@ -537,11 +537,11 @@ if you have one a single Cygwin installation, for example, if you update the
Cygwin package without exiting all Cygwin apps (including
services like sshd) beforehand.
The only DLL that is sanctioned by the Cygwin project is the one that
-you get by running setup-x86.exe or setup-x86_64.exe,
+you get by running the Cygwin Setup program,
installed in a directory controlled by this program. If you have other
versions on your system and desire help from the cygwin project, you should
delete or rename all DLLs that are not installed by
-setup.exe.
+the Cygwin Setup program.
If you're trying to find multiple versions of the DLL that are causing
this problem, reboot first, in case DLLs still loaded in memory are the
@@ -882,7 +882,7 @@ this is still a problem, however.)
hang when unpacking tar.gz archives. This is surely a bug in VirusScan,
and should be reported to NAI. The only workaround is to disable
VirusScan when accessing these files. This can be an issue during
-setup, and is discussed in that FAQ entry.
+Setup, and is discussed in that FAQ entry.
Some users report a significant performance hit using Cygwin when their
anti-virus software is enabled. Rather than disable the anti-virus
@@ -1402,10 +1402,10 @@ such as virtual memory paging and file caching.
Force a full rebase: Run rebase-trigger fullrebase,
- exit all Cygwin programs and run Cygwin setup.
+ exit all Cygwin programs and run the Cygwin Setup program.
- By default, Cygwin's setup program automatically performs an incremental
+ By default, the Cygwin Setup program automatically performs an incremental
rebase of newly installed files. Forcing a full rebase causes the
rebase map to be cleared before doing the rebase.
@@ -1448,11 +1448,12 @@ such as virtual memory paging and file caching.
They also may not provide any obvious way to keep the Cygwin packages
their application uses up to date with fixes for security issues and
upgrades.
- The solution is simply downloading and running Cygwin Setup,
- following the instructions in the Internet Setup section of
+ The solution is simply downloading and running the Cygwin Setup program,
+ following the instructions in the
- Setting Up Cygwin in the Cygwin User's Guide.
- Please exit from all applications before running Cygwin Setup.
+ Internet Setup section of ``Setting Up Cygwin'' in the
+ Cygwin User's Guide.
+ Please exit from all applications before running the Cygwin Setup program.
When running Setup, you should not change most of the values presented,
just select the Next button in most cases, as you
already have a Cygwin release installed, and only want to upgrade your
@@ -1463,7 +1464,7 @@ such as virtual memory paging and file caching.
faster downloads, as shown, with more details to help you choose, on the
Mirror Sites web page.
- Cygwin Setup will download and apply upgrades to all packages
+ The Cygwin Setup program will download and apply upgrades to all packages
required for Cygwin itself and installed applications.
Any problems with applying updates, or the application after updates,
should be reported to the project or product supplier for remedial