From 1b4b6a7cd517dd1fd672abe1553472bf3e2cb375 Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Sun, 18 Mar 2012 20:30:42 +0100 Subject: [PATCH] cli: Same order for params in manpage and -h. --- doc/sigrok-cli.1 | 48 ++++++++++++++++++++++++------------------------ sigrok-cli.c | 4 ++-- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index a8b1f83..58dcf1e 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -2,7 +2,7 @@ .SH "NAME" sigrok\-cli \- Command-line client for the sigrok logic analyzer software .SH "SYNOPSIS" -.B sigrok\-cli \fR[\fB\-hVlDiIoOdptwas\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR list] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR] +.B sigrok\-cli \fR[\fB\-hVlDdiIoOptwas\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR list] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR] .SH "DESCRIPTION" .B sigrok\-cli is a cross-platform command line utility for the @@ -43,6 +43,29 @@ number, the more debug output will be printed. Valid loglevels are List all logic analyzer devices found on the system. This actively scans for devices (USB, serial port, and others). .TP +.BR "\-d, \-\-device " +The device to use for acquisition. It can be specified by ID as reported by +.BR "\-\-list\-devices" , +or by the name of the driver as reported by +.BR \-\-version . +.sp +A device can optionally be followed by a colon-separated list of device +options, where each option takes the form +.BR key=value . +For example, to set the samplerate on the first device you might specify +.sp +.RB " $ " "sigrok\-cli \-d 0:samplerate=1m" +.sp +Samplerate is an option common to most devices. The argument specifies the +samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz. +The following are all equivalent: +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1000000" +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m" +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz"" +.TP .BR "\-i, \-\-input\-file " Load input from a file instead of a hardware device. If the .B \-\-input\-format @@ -99,29 +122,6 @@ like this: 1:11111111 11111111 11111111 11111111 [...] 2:11111111 00000000 11111111 00000000 [...] .TP -.BR "\-d, \-\-device " -The device to use for acquisition. It can be specified by ID as reported by -.BR "\-\-list\-devices" , -or by the name of the driver as reported by -.BR \-\-version . -.sp -A device can optionally be followed by a colon-separated list of device -options, where each option takes the form -.BR key=value . -For example, to set the samplerate on the first device you might specify -.sp -.RB " $ " "sigrok\-cli \-d 0:samplerate=1m" -.sp -Samplerate is an option common to most devices. The argument specifies the -samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz. -The following are all equivalent: -.sp -.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1000000" -.sp -.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m" -.sp -.RB " $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz"" -.TP .BR "\-p, \-\-probes " A comma-separated list of probes to be used in the session. .sp diff --git a/sigrok-cli.c b/sigrok-cli.c index f1de7aa..053591f 100644 --- a/sigrok-cli.c +++ b/sigrok-cli.c @@ -67,15 +67,15 @@ static GOptionEntry optargs[] = { {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version, "Show version and support list", NULL}, {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel, "Select libsigrok loglevel", NULL}, {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devs, "List devices", NULL}, + {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev, "Use specified device", NULL}, {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, "Load input from file", NULL}, {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, "Input format", NULL}, {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, "Save output to file", NULL}, {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format, "Output format", NULL}, - {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev, "Use device ID", NULL}, {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, "Probes to use", NULL}, {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers, "Trigger configuration", NULL}, {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger, "Wait for trigger", NULL}, - {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoder sequence", NULL}, + {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoders to run", NULL}, {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack, "Protocol decoder stack", NULL}, {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL}, {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples, "Number of samples to acquire", NULL}, -- 2.30.2