aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md28
1 files changed, 18 insertions, 10 deletions
diff --git a/README.md b/README.md
index eb39573..497353d 100644
--- a/README.md
+++ b/README.md
@@ -24,20 +24,28 @@ the `packages` parameter.
(C:\tools\cygwin is the default).
* The `CYGWIN` environment variable is set to an empty string by default.
Provide a custom value using the `env` parameter.
+* Some packages install symlinks in /usr/bin along with real executables.
+An example is package python3, which (as of January 2021) installs symlink
+"python3", pointing to the real executable "python3.8.exe".
+Calling Cygwin symlinks from Windows' command prompt is unsupported, but
+there's an option to convert them to hardlinks instead (the
+`symlinks-to-hardlinks` parameter).
API
---
-| Input | Value | Default | Description
-| ----------- | ------- | ------- | -----------
-| platform | x64 | Yes | Install the 64-bit version.
-| | *Other* | No | Install the 32-bit version.
-| install-dir | *Empty* | Yes | Install to C:\tools\cygwin.
-| | *Other* | No | Install to the specified directory.
-| packages | *Empty* | Yes | Don't install any additional packages.
-| | *Other* | No | Space-separated package names.
-| env | *Empty* | Yes | Set `%CYGWIN%` to an empty string.
-| | *Other* | No | Set `%CYGWIN%` to the specified value.
+| Input | Value | Default | Description
+| --------------------- | ------- | ------- | -----------
+| platform | x64 | Yes | Install the 64-bit version.
+| | *Other* | No | Install the 32-bit version.
+| install-dir | *Empty* | Yes | Install to C:\tools\cygwin.
+| | *Other* | No | Install to the specified directory.
+| packages | *Empty* | Yes | Don't install any additional packages.
+| | *Other* | No | Space-separated package names.
+| env | *Empty* | Yes | Set `%CYGWIN%` to an empty string.
+| | *Other* | No | Set `%CYGWIN%` to the specified value.
+| symlinks-to-hardlinks | *Other* | Yes | Don't convert any symlinks.
+| | 1 | No | Convert symlinks in /usr/bin to hardlinks.
The paths to the Cygwin binaries are added to the PATH variable.