Skip to content

Commit 6561731

Browse files
committed
Updated documentation
1 parent 5b6ffa5 commit 6561731

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,13 @@ git clone https://github.com/wireghoul/graudit
1919

2020
You can then symlink graudit so it is in path:
2121
```
22-
ln -s ~/graudit/graudit ~/bin/graudit
22+
ln -s path/to/graudit/graudit ~/bin/graudit
23+
```
24+
25+
If graudit is not in your home directory you may wish to set the GRDIR
26+
environment variable to the signatures directory in your `.bashrc` file.
27+
```
28+
export GRDIR=/path/to/graudit/signatures
2329
```
2430

2531
Usage
@@ -60,10 +66,11 @@ follows:
6066
1. Custom location specified via the GRDIR environment variable
6167
2. /usr/share/graudit/
6268
3. $HOME/.graudit/
63-
4. A relative signature/ directory from the graudit location
69+
4. A relative signatures/ directory from the graudit location
6470
5. A relative misc/ directory from the graudit location
65-
6. Any file that is specified with a full path, i.e: /home/user/my.db
66-
7. Rules can be read from stdin by supplying - or /dev/stdin as the database
71+
6. $HOME/graudit/signatures/
72+
7. Any file that is specified with a full path, i.e: /home/user/my.db
73+
8. Rules can be read from stdin by supplying - or /dev/stdin as the database
6774

6875
A list of the database files in order of precedence is shown with the -l switch:
6976
`graudit -l`

0 commit comments

Comments
 (0)