From 28285b14e0c992b4c4c2753086c7b6186e748edb Mon Sep 17 00:00:00 2001 From: Romain Bignon Date: Mon, 5 Apr 2021 13:59:38 +0200 Subject: [PATCH] update doc related to 'woob update' and local_run.sh --- INSTALL | 8 ++++---- docs/source/guides/setup.rst | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/INSTALL b/INSTALL index bd9bc6041a..6b0f33e555 100644 --- a/INSTALL +++ b/INSTALL @@ -14,7 +14,7 @@ The requirements are provided in ``setup.py``, except for: Some modules may have more dependencies. -After a package or system installation, you should run ``woob config update`` +After a package or system installation, you should run ``woob update`` as your login user. There are 2 versions of woob: @@ -31,7 +31,7 @@ No need to use the git repository in this case. Just This pip installation can be run within a virtualenv if desired (don't add ``--user``). -Then `woob-config update` can be run to fetch the list of available modules, +Then `woobupdate` can be run to fetch the list of available modules, and the various woob commands (woob bank, woob video, etc.) can be run and are able to install modules. @@ -73,12 +73,12 @@ This does not actually install anything, but lets you run Woob from the source code, while also using the modules from that source. This is only recommended if using the git source and not a release. :: - $ ./tools/local_run.sh APPLICATION COMMANDS + $ ./tools/local_run.sh COMMAND [args ..] For example, instead of running ``woob video -b youtube search plop``, you would run:: - $ ./tools/local_run.sh woob video -b youtube search plop + $ ./tools/local_run.sh video -b youtube search plop Bash completion --------------- diff --git a/docs/source/guides/setup.rst b/docs/source/guides/setup.rst index 8e96425715..5b37ee4b4e 100644 --- a/docs/source/guides/setup.rst +++ b/docs/source/guides/setup.rst @@ -36,7 +36,7 @@ a new one, you have to add this line at end of ``~/.config/woob/sources.list``:: Then, run this command:: - $ woob config update + $ woob update Run woob without installation ------------------------------- @@ -44,11 +44,11 @@ Run woob without installation This does not actually install anything, but lets you run woob from the source code, while also using the modules from that source:: - $ ./tools/local_run.sh APPLICATION COMMANDS + $ ./tools/local_run.sh COMMAND [args ..] -For example, instead of running `videoob -b youtube search plop`, you would run:: +For example, instead of running `woob video -b youtube search plop`, you would run:: - $ ./tools/local_run.sh videoob -b youtube search plop + $ ./tools/local_run.sh video -b youtube search plop Conclusion -- GitLab