diff options
author | Bryn M. Reeves <bmr@redhat.com> | 2016-10-18 13:52:31 +0100 |
---|---|---|
committer | Bryn M. Reeves <bmr@redhat.com> | 2016-10-18 13:52:31 +0100 |
commit | c9ac32b1ce157583db00961c7964abd94b4a9271 (patch) | |
tree | 6a829bb4d5113b3181d4d4d40a73b995d41743a2 | |
parent | 48bf98f5a0e451a8713e59aa0a1d41bac8ecf76f (diff) | |
download | sos-c9ac32b1ce157583db00961c7964abd94b4a9271.tar.gz |
[docs] document use of --config with in-tree builds
-rw-r--r-- | README.md | 28 |
1 files changed, 24 insertions, 4 deletions
@@ -56,11 +56,31 @@ pull requests. ### Manual Installation +You can simply run from the git checkout now: ``` -You can simply run from the git checkout now ==> Ex: sudo ./sosreport -a -or if you only have python3 installed ==> sudo python3 ./sosreport -a -to install locally (as root) ==> make install -to build an rpm ==> make rpm +$ sudo ./sosreport -a +``` + +Or, if you only have python3 installed: +``` +$ sudo python3 ./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 +``` + +To install locally (as root): +``` +# make install +``` + +To build an rpm: +``` +$ make rpm ``` ### Pre-built Packaging |