aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJose Castillo <jcastillo@redhat.com>2020-05-12 11:09:00 +0100
committerJake Hunsaker <jhunsake@redhat.com>2020-05-19 11:35:12 -0400
commit5c40af812a71129b770591aa9925352b10f34e31 (patch)
tree84bedbd058d99501dcb91aa71ae9106b37f36b34 /README.md
parent1875213788f4472cc11ce8e732cd4780e99ca477 (diff)
downloadsos-5c40af812a71129b770591aa9925352b10f34e31.tar.gz
[doc] Update path to the sosreport command.
The documentation references ./sosreport , but the command now lives inside ./bin, so this commit updates such references. Resolves: #2060 Signed-off-by: Jose Castillo <jcastillo@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4b0f52ca..650fb05a 100644
--- a/README.md
+++ b/README.md
@@ -74,19 +74,19 @@ pull requests.
You can simply run from the git checkout now:
```
-$ sudo ./sosreport -a
+$ sudo ./bin/sos report -a
```
-
-Or, if you only have python3 installed:
+The command `sosreport` is still available, as a legacy rediretor,
+and can be used like this:
```
-$ sudo python3 ./sosreport -a
+$ sudo ./bin/sosreport -a
```
* Note: the `sosreport` command requires a configuration file: if no `sos.conf`
is present in the `/etc` directory (i.e. no system installation of sos exists),
use the `--config` option to provide one:
```
-$ sudo python ./sosreport -a --config ./sos.conf
+$ sudo python ./bin/sos report -a --config ./sos.conf
```
To install locally (as root):