diff --git a/winsup/utils/ChangeLog b/winsup/utils/ChangeLog index a21d0a9de..bb126b227 100644 --- a/winsup/utils/ChangeLog +++ b/winsup/utils/ChangeLog @@ -1,3 +1,8 @@ +2009-04-03 Kevin Buettner + + * utils.sgml: Various syntactical and semantical fixes. + * cygcheck.cc (usage): Fix --find-package explanation. + 2009-03-26 Yaakov Selkowitz * utils.sgml (passwd -R): Remove references to CYGWIN="server". diff --git a/winsup/utils/cygcheck.cc b/winsup/utils/cygcheck.cc index 052707ffe..10738a145 100644 --- a/winsup/utils/cygcheck.cc +++ b/winsup/utils/cygcheck.cc @@ -1984,7 +1984,7 @@ At least one command option or a PROGRAM is required, as shown above.\n\ -r, --registry also scan registry for Cygwin settings (with -s)\n\ -k, --keycheck perform a keyboard check session (must be run from a\n\ plain console only, not from a pty/rxvt/xterm)\n\ - -f, --find-package find the package that FILE belongs to\n\ + -f, --find-package find the package to which FILE belongs\n\ -l, --list-package list contents of PACKAGE (or all packages if none given)\n\ -p, --package-query search for REGEXP in the entire cygwin.com package\n\ repository (requires internet connectivity)\n\ diff --git a/winsup/utils/utils.sgml b/winsup/utils/utils.sgml index 8593bd348..e78aa120d 100644 --- a/winsup/utils/utils.sgml +++ b/winsup/utils/utils.sgml @@ -32,7 +32,7 @@ At least one command option or a PROGRAM is required, as shown above. -r, --registry also scan registry for Cygwin settings (with -s) -k, --keycheck perform a keyboard check session (must be run from a plain console only, not from a pty/rxvt/xterm) - -f, --find-package find the package that FILE belongs to + -f, --find-package find the package to which FILE belongs -l, --list-package list contents of PACKAGE (or all packages if none given) -p, --package-query search for REGEXP in the entire cygwin.com package repository (requires internet connectivity) @@ -373,7 +373,7 @@ ACL. For directories getfacl displays additionally the default ACL. With no options specified, getfacl displays the filename, the owner, the group, and both the ACL and the default ACL, if it exists. For more information on Cygwin and Windows ACLs, see -see in the Cygwin User's Guide. + in the Cygwin User's Guide. The format for ACL output is as follows: # file: filename @@ -442,7 +442,7 @@ given signal, or a list of all signal names if no signal is given. To send a specific signal, use the -signN option, either with a signal number or a signal name (minus the "SIG" -part), like these examples: +part), as shown in these examples: Using the kill command @@ -560,14 +560,14 @@ With the -d/-D options the program contacts a Domain Controller, which my be unreachable or have restricted access. Comma-separated from the machine or domain, you can specify an offset which is used as base added to the group's RID to compute the gid -(offset + RID = gid). This allows to create the same gids every time you +(offset + RID = gid). This allows you to create the same gids every time you re-run mkgroup. For very simple needs, an entry for the current user's group can be created by using the option -c or -C. If you want to use one of the -D, -L or -C options, but you don't like the backslash as domain/group separator, you can specify another separator using the --S option, for instance +-S option, for instance: Setting up group entry for current user with different domain/group separator @@ -580,11 +580,11 @@ DOMAIN+my_group:S-1-5-21-2913048732-1697188782-3448811101-1144:11144: The -o option allows for special cases (such as multiple domains) where the GIDs might match otherwise. The -g option only prints the information for one group. -The -U option allows to enumerate the standard UNIX +The -U option allows you to enumerate the standard UNIX groups on a Samba machine. It's used together with -l samba-server or -L samba-server. The normal UNIX groups are usually not enumerated, but they can show -up as group in ls -l output. +up as a group in ls -l output. @@ -667,7 +667,7 @@ option -c or -C. If you want to use one of the -D, -L or -C options, but you don't like the backslash as domain/group separator, you can specify another separator using the --S option, simialar to the mkgroup. +-S option, similar to the mkgroup. The -o option allows for special cases (such as multiple domains) where the UIDs might match otherwise. The -m option bypasses the current @@ -687,7 +687,7 @@ use the specified prefix instead of the account home dir or /home/ would put local users' home directories in the Windows 'Profiles' directory. The -u option creates just an entry for the specified user. -The -U option allows to enumerate the standard UNIX +The -U option allows you to enumerate the standard UNIX users on a Samba machine. It's used together with -l samba-server or -L samba-server. The normal UNIX users are usually not enumerated, but they can show @@ -808,7 +808,7 @@ the /etc/fstab file. The -m option causes the mount utility -to output the current mount table in a series of fstab entries. This allows +to output the current mount table in a series of fstab entries. You can save this output as a backup when experimenting with the mount table. Copy the output to /etc/fstab to restore the old state. It also makes moving your settings to a different machine much easier. @@ -1017,13 +1017,13 @@ running Windows services. When a privileged Cygwin application calls the set{e}uid(user_id) system call, Cygwin checks if a password for that user has been stored in this registry area. If so, it uses this password to switch to this user account using that password. -This allows to logon through, for instance, ssh with -public key authentication and to get a full qualified user token with +This allows you to logon through, for instance, ssh with +public key authentication and get a full qualified user token with all credentials for network access. However, the method has some -drawbacks security-wise. This is explained in more detail in the - section. +drawbacks security-wise. This is explained in more detail in +. -Please note that storing password in that registry area is a +Please note that storing passwords in that registry area is a privileged operation which only administrative accounts are allowed to do. If normal, non-admin users should be allowed to enter their passwords using passwd -R, it's required to run @@ -1078,7 +1078,7 @@ waiting to output. -By default ps will only show processes owned by the +By default, ps will only show processes owned by the current user. With either the -a or -e option, all user's processes (and system processes) are listed. There are historical UNIX reasons for the synonomous options, which are functionally @@ -1166,18 +1166,18 @@ Conversely, the -q option supresses error messages, so you can use the exit status of the program to detect if a key exists or not (for example). -The -w option allows to access the 64 bit view -on the registry. Several subkeys exist in a 32 bit and a 64 bit version +The -w option allows you to access the 64 bit view +of the registry. Several subkeys exist in a 32 bit and a 64 bit version when running on Windows 64. Since Cygwin is running in 32 bit mode, it -has only access to the 32 bit view of these registry keys. When using -the -w the 64 bit view is used and +only has access to the 32 bit view of these registry keys. When using +the -w switch, the 64 bit view is used and regtool can access the entire registry. This option is simply ignored when running on 32 bit Windows versions. -The -W option allows to access the 32 bit view -on the registry. The purpose of this option is mainly symmetry. It -allows to create OS agnostic scripts which would also work in a hypothetic +The -W option allows you to access the 32 bit view +on the registry. The purpose of this option is mainly for symmetry. It +permits creation of OS agnostic scripts which would also work in a hypothetical 64 bit version of Cygwin. You must provide regtool with an @@ -1190,7 +1190,7 @@ the action must be add, set, The add action adds a new key. The check action checks to see if a key exists (the exit code of the program is zero if it does, nonzero if it does not). -The get action gets the value of a value of a key, +The get action gets the value of a key, and prints it (and nothing else) to stdout. Note: if the value doesn't exist, an error message is printed and the program returns a non-zero exit code. If you give -q, it doesn't