diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2021-04-29 04:06:24 +0300 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2021-04-29 04:08:08 +0300 |
| commit | 351e33032eaa34e223abb64cec5b5dd51703d8d9 (patch) | |
| tree | 4c22980b52f4a813104a40eb5c1659f22a619d62 | |
| parent | README: add more badges (diff) | |
| download | config-links-351e33032eaa34e223abb64cec5b5dd51703d8d9.tar.gz config-links-351e33032eaa34e223abb64cec5b5dd51703d8d9.zip | |
README: update
| -rw-r--r-- | README.md | 17 |
1 files changed, 9 insertions, 8 deletions
@@ -24,23 +24,24 @@ corresponding symlink is then deleted too). The default database file name is "links.bin", maintained in the top-level directory with shared files. -This description is obviously confusing; see the complete usage example below. +For a complete usage example, see below. Usage ----- -Symlinks are managed by `links-update`. +Symlinks are created & maintained by `links-update`. ``` usage: links-update [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run] ``` -Pass the `--help` flag to this script to examine its detailed usage -information. +To remove all symlinks, use `links-remove`. -A complete usage example is given below. -In this example, the symlinks to files in "../src" must appear in -"/test/dest". +``` +usage: links-remove [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run] +``` + +In this example, symlinks to files in "../src" must appear in "/test/dest". ``` > tree /test/dest/ @@ -80,7 +81,7 @@ In this example, the symlinks to files in "../src" must appear in 5 directories, 2 files ``` -For more realistic usage examples, see +For my personal real-life usage examples, see * my [Linux/Cygwin environment], * configuration files for various [Windows apps]. |