aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-10-08 14:06:59 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-10-08 14:06:59 +0300
commitc776b963021c97e5754a25ec0843f0bdee62caaa (patch)
tree5d7d161c750b361d11ab225d7e966e6b8280b783
parentremove fix_nt_symbol_path.exe (diff)
downloadwindows-env-c776b963021c97e5754a25ec0843f0bdee62caaa.tar.gz
windows-env-c776b963021c97e5754a25ec0843f0bdee62caaa.zip
README update
Diffstat (limited to '')
-rw-r--r--README.md29
1 files changed, 24 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9028a40..4c07b4e 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
Windows environment variables
=============================
-A collection of simple programs to manage environment variables on Windows,
+A collection of simple utilities to manage Windows environment variables,
created mainly to:
* learn a bit of Haskell,
-* make it easier to add paths to the `PATH` variable, automatically setup
-`_NT_SYMBOL_PATH`, etc.
+* make it easier to add directories to the `PATH` variable, list missing
+directories in your `PATH`, etc.
Building
--------
@@ -18,6 +18,7 @@ Using [stack]:
...
> stack build
+...
```
[stack]: http://docs.haskellstack.org/en/stable/README/
@@ -27,6 +28,7 @@ Installation
```
> stack install
+...
```
Usage
@@ -40,7 +42,7 @@ The complete list of utilities is given below.
* [set_env] &mdash; Set environment variables.
* [unset_env] &mdash; Unset environment variables.
-Pass the `--help` flag to a utility to examine its detailed usage information.
+Pass the `--help` flag to an utility to examine its detailed usage information.
Some examples are given below.
[list_path]: #list_path
@@ -51,7 +53,7 @@ Some examples are given below.
### list_path
-List directories in your `PATH` variable:
+List directories in your `PATH`:
```
> list_path
@@ -63,6 +65,8 @@ C:\Users\Egor\AppData\Roaming\cabal\bin
...
```
+Only list missing directories in your `PATH`:
+
```
> list_path --missing
C:\Users\Egor\AppData\Roaming\cabal\bin
@@ -83,8 +87,23 @@ Continue? (y/n) y
>
```
+Add "C:\test" to global `PATH`, skipping the confirmation prompt:
+
+```
+> add_path --global -y C:\test
+```
+
### remove_path
+Remove "C:\test" from current user's `PATH`:
+
+```
+> remove_path C:\test
+Saving variable 'PATH' to 'HKCU\Environment'...
+ Old value: C:\Users\Egor\AppData\Roaming\local\bin;C:\Users\Egor\AppData\Roaming\cabal\bin;C:\test
+ New value: C:\Users\Egor\AppData\Roaming\local\bin;C:\Users\Egor\AppData\Roaming\cabal\bin
+```
+
Remove "C:\test" from both current user's and global `PATH`s, skipping the
confirmation prompt: