X-Git-Url: http://git.code-monkey.de/?a=blobdiff_plain;f=manual%2Fcli.txt;fp=manual%2Fcli.txt;h=c7798dff31e25532baef3a3bbaf25b3361e09c70;hb=1894027b98640702a5229c4168c586df5f83a3af;hp=0000000000000000000000000000000000000000;hpb=39e047cffdbfdb6dd10f3367e600887553a89d74;p=pulseview.git

diff --git a/manual/cli.txt b/manual/cli.txt
new file mode 100644
index 0000000..c7798df
--- /dev/null
+++ b/manual/cli.txt
@@ -0,0 +1,42 @@
+== Command-line Interface
+
+Even though PulseView has a graphical user interface, there is also a command-line interface that
+you can make use of. It is meant to provide functions for convenience and debug purposes, not to
+replace the user interface itself.
+
+Running 
+
+	pulseview -h
+
+gives you a list of these functions.
+
+Since PulseView can't automatically scan for devices connected to a COM port (ttySx on Linux) or
+Ethernet, you can tell it to look for a specific device using the -d or --driver parameter. Its
+usage is the same as for sigrok-cli. For example:
+
+	pulseview -d lecroy-xstream:conn=vxi/192.168.178.20/111
+
+Also, just as with sigrok-cli, you can specify -i / --input-file and -I / --input-format to open
+a file on startup. Without -I, it is assumed that the file is in the native sigrok format (.sr).
+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
+
+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 
+	-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.
+
+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.
+
+Thus, the combination of both parameters can be seen as some kind of "safe mode" for PulseView:
+
+	pulseview -D -c