From 7e8031a5fd356f205e08a3297d8da83f42e6b8ae Mon Sep 17 00:00:00 2001 From: Jon Turney Date: Mon, 10 Jan 2022 18:22:17 +0000 Subject: [PATCH] Cygwin: doc: drop mention of 32-bit installer Drop mention of 32-bit installer, since it's offically discouraged, and planned to be dropped soon. Adjust various references to be something more generic, like 'the Cygwin Setup program' to accommodate this. --- winsup/doc/faq-setup.xml | 12 +++---- winsup/doc/setup-net.xml | 74 ++++++++++++++++------------------------ 2 files changed, 34 insertions(+), 52 deletions(-) diff --git a/winsup/doc/faq-setup.xml b/winsup/doc/faq-setup.xml index c04ffe9a5..740c6fefb 100644 --- a/winsup/doc/faq-setup.xml +++ b/winsup/doc/faq-setup.xml @@ -12,9 +12,8 @@ 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. +Cygwin Setup program, a GUI installer. +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. @@ -191,7 +190,6 @@ Here is how Cygwin secures the installation and update process to counter The Cygwin website provides the Cygwin Setup program -(setup-x86.exe or setup-x86_64.exe) using HTTPS (SSL/TLS). This authenticates that the Cygwin Setup program came from the Cygwin website @@ -261,8 +259,7 @@ widely-used SHA-2 suite of cryptographic hashes). To best secure your installation and update process, download -the Cygwin Setup program setup-x86_64.exe (64-bit) or -setup-x86.exe (32-bit), and then +the Cygwin Setup program, and then check its signature (using a signature-checking tool you trust) using the Cygwin public key (). @@ -318,8 +315,7 @@ archives. If this happens to you, consider disabling your anti-virus software when running the Cygwin Setup program. The following procedure should be a fairly safe way to do that: -Download setup-x86_64.exe or -setup-x86.exe and scan it explicitly. +Download the Cygwin Setup program and scan it explicitly. Turn off the anti-virus software. diff --git a/winsup/doc/setup-net.xml b/winsup/doc/setup-net.xml index 82b1e0dc9..db39bb66c 100644 --- a/winsup/doc/setup-net.xml +++ b/winsup/doc/setup-net.xml @@ -8,9 +8,7 @@ Internet Setup To install the Cygwin net release, go to and run either -setup-x86.exe -to install the 32 bit version of Cygwin, or +url="https://cygwin.com/"/> and run setup-x86_64.exe to install the 64 bit version of Cygwin. This will download a GUI installer which can be run to download a complete cygwin installation @@ -18,33 +16,21 @@ via the internet. Follow the instructions on each screen to install Cygwin. - -For easier reading the installer is called setup.exe -throughout the following sections. This refers likewise to both -installer applications, -setup-x86.exe -for 32 bit, as well as -setup-x86_64.exe -for 64 bit. Apart from the target architecture they are the same thing. - - - - -The setup.exe installer is designed to be easy +The setup installer is designed to be easy for new users to understand while remaining flexible for the experienced. The volunteer development team is constantly working -on setup.exe; before requesting a new feature, +on setup; before requesting a new feature, check the wishlist in the Git README . It may already be present in the Git version! -On Windows Vista and later, setup.exe will check by +On Windows Vista and later, setup will check by default if it runs with administrative privileges and, if not, will try to elevate the process. If you want to avoid this behaviour and install under an unprivileged account just for your own usage, run -setup.exe with the --no-admin option. +setup with the --no-admin option. @@ -54,7 +40,7 @@ installed by simply clicking the Next button at each page. The only exception to this is choosing a Cygwin mirror, which you can choose by experimenting with those listed at . For more details about each of page of the -setup.exe installation, read on below. +setup installation, read on below. Please note that this guide assumes that you have a basic understanding of Unix (or a Unix-like OS). If you are new to Unix, you will also want to make use of @@ -65,7 +51,7 @@ other resources. Cygwin uses packages to manage installing various software. When the default Install from Internet option is chosen, -setup.exe creates a local directory to store +setup creates a local directory to store the packages before actually installing the contents. Download from Internet performs only the first part (storing the packages locally), while @@ -79,8 +65,8 @@ installation on several machines with Install from Local Directory; copy the entire local package tree to another machine with the directory tree intact. For example, you might create a C:\cache\ -directory and place setup.exe in it. Run -setup.exe to Install from Internet +directory and place setup in it. Run +setup to Install from Internet or Download from Internet, then copy the whole C:\cache\ to each machine and instead choose Install from Local Directory. @@ -119,10 +105,10 @@ programs, consult the Cygwin mailing list archives about others' experiences. Local Package Directory The Local Package Directory is the cache where -setup.exe stores the packages before they are +setup stores the packages before they are 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 +Cygwin mirror, which allows setup to use multiple mirrors and custom packages. After installing Cygwin, the cache is no longer necessary, but you may want to retain the packages as backups, for installing Cygwin to another system, @@ -155,30 +141,30 @@ mirror) you can add it. Choosing Packages -For each selected mirror site, setup.exe downloads a +For each selected mirror site, setup downloads a small text file called setup.bz2 that contains a list of packages available from that site along with some basic information about -each package which setup.exe parses and uses to create the +each package which setup parses and uses to create the chooser window. For details about the format of this file, see the -setup.exe homepage. +setup homepage. -The chooser is the most complex part of setup.exe. +The chooser is the most complex part of setup. 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 hierarchical chooser view. -By default, setup.exe +By default, setup will install only the packages in the Base category 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). Since setup.exe automatically selects +category). Since setup automatically selects dependencies, be careful not to unselect any required packages. In particular, everything in the Base category is required. -You can change setup.exe's view style, which is helpful +You can change setup's view style, which is helpful if you know the name of a package you want to install but not which category it is in. Click on the View button and it will rotate between @@ -189,12 +175,12 @@ If you are familiar with Unix, you will probably want to at least glance through the Full listing for your favorite tools. -Once you have an existing Cygwin installation, the setup.exe +Once you have an existing Cygwin installation, the setup chooser is also used to manage your Cygwin installation. Information on installed packages is kept in the /etc/setup/ directory of your Cygwin installation; if -setup.exe cannot find this directory it will act as if -you have no Cygwin installation. If setup.exe +setup cannot find this directory it will act as if +you have no Cygwin installation. If setup finds a newer version of an installed package available, it will automatically mark it to be upgraded. To Uninstall, Reinstall, or get the @@ -202,7 +188,7 @@ To Uninstall, Reinstall, or get the Keep to toggle it. Also, to avoid the need to reboot after upgrading, make sure to close all Cygwin windows and stop all Cygwin processes before -setup.exe begins to install the upgraded package. +setup begins to install the upgraded package. To avoid unintentionally upgrading, use the Pending @@ -222,7 +208,7 @@ Previous and experimental versions can be chosen by clicking on the package's All available experimental packages can be selected by pressing the Exp in the top right part of the chooser window. -Be warned, however, that the next time you run setup.exe +Be warned, however, that the next time you run setup it will try to replace all old or experimental versions with the current version, unless told otherwise. @@ -230,11 +216,11 @@ version, unless told otherwise. Download and Installation Progress -First, setup.exe will download all selected packages +First, setup will download all selected packages to the local directory chosen earlier. Before installing, -setup.exe performs a checksum on each package. If the +setup performs a checksum on each package. If the local directory is a slow medium (such as a network drive) this can take -a long time. During the download and installation, setup.exe +a long time. During the download and installation, setup shows progress bars for the current task and total remaining disk space. @@ -250,9 +236,9 @@ in /etc/passwd. Post-Install Scripts -Last of all, setup.exe will run any post-install +Last of all, setup will run any post-install scripts to finish correctly setting up installed packages. -When the last post-install script is completed, setup.exe +When the last post-install script is completed, setup 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/ @@ -265,9 +251,9 @@ Unfortunately, the complex setup process means that odd problems can occur. If you're having trouble downloading packages, it may be network congestion, so try a different mirror and/or a different protocol (i.e., HTTP instead of FTP). If you notice something is not working after -running setup, you can check the setup.exe log file +running setup, you can check the setup log file at /var/log/setup.log.full. Make a backup of this -file before running setup.exe again, and follow the +file before running setup again, and follow the steps for Reporting Problems with Cygwin.