Add -s / --settings parameter to load a session setup file

[pulseview.git] / manual / cli.txt

diff --git a/manual/cli.txt b/manual/cli.txt
index c7798dff31e25532baef3a3bbaf25b3361e09c70..6187dbb986be218e164fccd0d7e436efc06e23c8 100644 (file)
--- a/manual/cli.txt
+++ b/manual/cli.txt
@@ -21,22 +21,30 @@ a file on startup. Without -I, it is assumed that the file is in the native sigr
 You can also specify more than one file but they are all expected to be in the same format then.
 Example:
 
-       pulseview -i data.vcd -I vcd
+       pulseview -i data.csv -I csv:samplerate=3000000
+
+If you previously saved a PulseView session setup alongside your input file, PulseView will
+automatically load those settings so long as the setup file (.pvs) has the same base name
+as your input file.
+You can also manually specify a PulseView session setup file to load with -s / --settings.
+Example:
+
+       pulseview -s settings.pvs data.sr
 
 The remaining parameters are mostly for debug purposes:
 
        -V / --version          Shows the release version
        -l / --loglevel         Sets the libsigrok/libsigrokdecode log level (max is 5)
-       -D / --no-scan          Don't auto-scan 
+       -D / --dont-scan        Don't auto-scan for devices
        -c / --clean            Don't restore previous sessions on startup
 
-Of these, -D can be useful when PulseView gets stuck during the startup device scan. No such
-scan will be performed then, allowing the program to start up but you'll have to scan for your
-acquisition device(s) manually before you can use them then.
+Of these, -D / --dont-scan can be useful when PulseView gets stuck during the startup device scan.
+No such scan will be performed then, allowing the program to start up but you'll have to scan for
+your acquisition device(s) manually before you can use them.
 
-Another potentially useful option is -c, which can be used when PulseView doesn't start up and
-you don't know what could cause this.
+Another potentially useful option is -c / --clean, which can be used when PulseView doesn't start
+up and you don't know what could cause this.
 
 Thus, the combination of both parameters can be seen as some kind of "safe mode" for PulseView:
 
-       pulseview -D -c
+       pulseview -c -D