Commit 3e84df26 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (stuploxx): set current list of options

The usage text displays the current set of implemented options on groups them
in a meaningful manner. The help text is accomplished by notes regarding
implemented and not yet implemented options.
parent 372682a0
......@@ -2,6 +2,61 @@
# ============================================================================
# parameter and options
# ---------------------
# v
# D
[-v] [-D]
# device
[-device dev]
# interactive
[-interactive]
# hdevice
[-hdevice dev]
# hcommand
[-hcommand c]
# repeat
[-repeat[=i]]
# repcmd
[-repcmd c]
# lwts (not implemented)
[-lwts l]
# chts (not implemented)
[-chts h]
# lwtg (not implemented)
[-lwtg l]
# spp (not implemented)
[-spp v]
# lwpb (not implemented)
[-lwpb l]
# chy
[-chy h]
# lwyg (not implemented)
[-lwyg l]
# lwys (not implemented)
[-lwys l]
# title
# tstitle
[-title t] [-tstitle v]
# labu
# labc
# labe
# labh
# labr
[-labu] [-labc] [-labe] [-labh v] [-labr]
# npanels
[-npanels n]
# datesep
[-datesep s]
# lyd
[-lyd v]
# help
or: stuploxx --help
# keys
or: stuploxx --keys
-v be verbose
-D debug mode
-interactive interactive mode
......
# this is <usage_text.txt>
# ============================================================================
# usage information
# -----------------
usage: stuploxx [-v] [-D] [-interactive] [-device dev]
#
# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach)
#
# stuploxx usage information
#
# ----
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
# REVISIONS and CHANGES
# 18/03/2015 V1.0 Thomas Forbriger (thof)
# list current set of active command line options
#
# ----------------------------------------------------------------------------
#
usage: stuploxx [-v] [-D] [-device dev]
# options to control automatic update mode
[-repeat[=i]] [-repcmd c]
file [t:n] [f:format] [p:n]
[s:min,max] [sf:f] [cs:v]
[lw:w] [ls:s] [ci:i] [r:r,g,b] [h:h,l,s]
[ch:h] [n:n] [u:units] [a:a] [A:a]
[file [t:n]...]
# v
# D
[-v] [-D]
# device
[-device dev]
# interactive
[-interactive]
# hdevice
[-hdevice dev]
# hcommand
[-hcommand c]
# repeat
[-repeat[=i]]
# repcmd
[-repcmd c]
# options to control interactive mode
[-interactive] [-hdevice dev] [-hcommand c]
# lwts (not implemented)
[-lwts l]
# [-lwts l]
# chts (not implemented)
[-chts h]
# [-chts h]
# lwtg (not implemented)
[-lwtg l]
# [-lwtg l]
# spp (not implemented)
[-spp v]
# [-spp v]
# lwpb (not implemented)
[-lwpb l]
# [-lwpb l]
# chy
[-chy h]
# [-chy h]
# lwyg (not implemented)
[-lwyg l]
# [-lwyg l]
# lwys (not implemented)
[-lwys l]
# title
# tstitle
[-title t] [-tstitle v]
# labu
# labc
# labe
# labh
# labr
[-labu] [-labc] [-labe] [-labh v] [-labr]
# npanels
[-npanels n]
# datesep
[-datesep s]
# lyd
[-lyd v]
# [-lwys l]
# options to control plot title
[-title t] [-tstitle v]
# options to control panel labels
[-labu] [-labc] [-labe] [-labh v] [-labr]
# further options
[-npanels n] [-datesep s] [-lyd v]
# file specific options and parameters
file [t:n] [f:format] [p:n]
[s:min,max] [sf:f] [cs:v]
[lw:w] [ls:s] [ci:i] [r:r,g,b] [h:h,l,s]
[ch:h] [n:n] [u:units] [a:a] [A:a]
[file [t:n]...]
# help
or: stuploxx --help
# keys
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment