Update README.rst with recent run options (#889)

web2py · Jul 7, 2024 · 830e3ef · 830e3ef
1 parent 17d52c6
commit 830e3ef
Showing 1 changed file with 32 additions and 25 deletions.
diff --git a/README.rst b/README.rst
@@ -75,35 +75,42 @@ Launch Arguments
 
    # py4web run -h
 
-   Usage: py4web.py run [OPTIONS] [APPS_FOLDER]
+   Usage: py4web.py run [OPTIONS] APPS_FOLDER
   
       Run all the applications on apps_folder
 
    Options:
-   -Y, --yes                     No prompt, assume yes to questions  [default:
-                                 False]
-   -H, --host TEXT               Host name  [default: 127.0.0.1]
-   -P, --port INTEGER            Port number  [default: 8000]
-   -p, --password_file TEXT      File for the encrypted password  [default:
-                                password.txt]
-   -s, --server [default|wsgiref|tornado|gunicorn|gevent|waitress|
-                   geventWebSocketServer|wsgirefThreadingServer|rocketServer]
-                                 server to use  [default: default]
-   -w, --number_workers INTEGER  Number of workers  [default: 0]
-   -d, --dashboard_mode TEXT     Dashboard mode: demo, readonly, full,
-                                 none  [default: full]
-   --watch [off|sync|lazy]       Watch python changes and reload apps
-                                 automatically, modes: off, sync, lazy
-                                 [default: lazy]
-   --ssl_cert PATH               SSL certificate file for HTTPS
-   --ssl_key PATH                SSL key file for HTTPS
-   --errorlog TEXT               Where to send error logs
-                                 (:stdout|:stderr|tickets_only|{filename})
-                                 [default: :stderr]
-   -L, --logging_level INTEGER   The log level (0 - 50) [default: 30
-                                 (=WARNING)]
-   -D, --debug                   Debug switch [default: False]
-   -help, -h, --help             Show this message and exit.
+  -Y, --yes                       No prompt, assume yes to questions
+  -H, --host TEXT                 Host listening IP  [default: 127.0.0.1]
+  -P, --port INTEGER              Port number  [default: 8000]
+  -A, --app_names TEXT            List of apps to run, comma separated (all if
+                                  omitted or empty)
+  -p, --password_file TEXT        File for the encrypted password  [default:
+                                  password.txt]
+  -Q, --quiet                     Suppress server output
+  -R, --routes                    Write apps routes to file
+  -s, --server [default|wsgiref|tornado|gunicorn|gevent|waitress|gunicorn|gunicornGevent|
+                                  gevent|geventWebSocketServer|geventWs|
+                                  wsgirefThreadingServer|wsgiTh|rocketServer]
+                                  Web server to use
+  -w, --number_workers INTEGER    Number of workers  [default: 0]
+  -d, --dashboard_mode TEXT       Dashboard mode: demo, readonly, full, none
+                                  [default: full]
+  --watch [off|sync|lazy]         Watch python changes and reload apps
+                                  automatically, modes: off, sync, lazy
+                                  [default: lazy]
+  --ssl_cert PATH                 SSL certificate file for HTTPS
+  --ssl_key PATH                  SSL key file for HTTPS
+  --errorlog TEXT                 Where to send error logs
+                                  (:stdout|:stderr|tickets_only|{filename})
+                                  [default: :stderr]
+  -L, --logging_level INTEGER     The log level (0 - 50) [default: 30
+                                  (=WARNING)]
+  -D, --debug                     Debug switch
+  -U, --url_prefix TEXT           Prefix to add to all URLs in and out
+  -m, --mode TEXT                 default or development  [default: default]
+  -h, -help, --help               Show this message and exit.
+