aboutsummarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorYash Karandikar2020-03-06 17:38:59 -0600
committerYash Karandikar2020-03-06 17:38:59 -0600
commit2693723bf9e3d4b3546cf66db57069a064394c4a (patch)
tree6069f0a5c114d73400a90159f91ace9ecf0246d4
parentde2c3b8fced4718cf64a9fa73a7fdb66089c8686 (diff)
downloadaur-2693723bf9e3d4b3546cf66db57069a064394c4a.tar.gz
Add section in README about configuration file
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index eac7da4baa5c..24b7374e2759 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,17 @@ Usage is pretty simple.
To install a package:
```bash
-haur <package name>
+haur <package names>
+```
+
+To upgrade a package:
+```bash
+haur -u <package names>
```
To remove a package:
```bash
-haur -r <package name>
+haur -r <package names>
```
Deleting a package only removes it from pacman, not the disk. To clear removed packages:
@@ -31,5 +36,16 @@ Deleting a package only removes it from pacman, not the disk. To clear removed p
haur -c
```
+## Configuration file
+
+You can use the configuration file to change the behaviour of haur. By default, the configuration file is stored in `/etc/haurrc`. However, you can also copy it to `~/.config/haurrc`. These are currently the only supported options.
+
+To disable colors (even if your terminal supports them), set `HAUR_NO_COLORS="y"`
+
+To clear cache even without specifying `-c`, set `HAUR_ALWAYS_CLEAR_CACHE="y"`
+
+If you think of another useful configuration option, tell me in a GitHub issue/pull request and/or an AUR comment.
+
+## Reporting issues
If you have any problems, please leave a comment on the AUR page and/or create a GitHub issue