Permalink
Browse files

man/client: update with new state option

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
  • Loading branch information...
Emantor committed Aug 10, 2017
1 parent 8089888 commit 3afe007fd23b1cb4fc17f8227d0be2942a141e81
Showing with 28 additions and 6 deletions.
  1. +11 −0 man/labgrid-client.1
  2. +17 −6 man/labgrid-client.rst
View
@@ -57,6 +57,10 @@ the crossbar url of the coordinator
.BI \-c \ CONFIG\fP,\fB \ \-\-config \ CONFIG
set the configuration file
.TP
.BI \-s \ STATE\fP,\fB \ \-\-state \ STATE
set an initial state before executing a command, requires a configuration
file and strategy
.TP
.B \-d\fP,\fB \-\-debug
enable debugging
.UNINDENT
@@ -69,6 +73,11 @@ Various labgrid\-client commands use the following environment variable:
.SS PLACE
.sp
This variable can be used to specify a place without using the \fB\-p\fP option, the \fB\-p\fP option overrides it.
.SS STATE
.sp
This variable can be used to specify a state which the device transitions into
before executing a command. Requires a configuration file and a Strategy
specified for the device.
.SH MATCHES
.sp
Match patterns are used to assign a resource to a specific place. The format is:
@@ -113,6 +122,8 @@ matches anything.
\fBfastboot\fP Run fastboot
.sp
\fBbootstrap\fP Start a bootloader
.sp
\fBio\fP Interact with Onewire devices
.SH EXAMPLES
.sp
To retrieve a list of places run:
View
@@ -9,22 +9,22 @@ labgrid-client interface to control boards
:organization: Labgrid-Project
:Date: 2017-04-15
:Copyright: Copyright (C) 2016-2017 Pengutronix. This library is free software;
you can redistribute it and/or modify it under the terms of the GNU
Lesser General Public License as published by the Free Software
Foundation; either version 2.1 of the License, or (at your option)
any later version.
you can redistribute it and/or modify it under the terms of the GNU
Lesser General Public License as published by the Free Software
Foundation; either version 2.1 of the License, or (at your option)
any later version.
:Version: 0.0.1
:Manual section: 1
:Manual group: embedded testing
SYNOPSIS
--------
``labgrid-client`` ``--help``
``labgrid-client`` ``--help``
``labgrid-client`` -p <place> <command>
``labgrid-client`` ``places|resources``
``labgrid-client`` ``places|resources``
DESCRIPTION
-----------
@@ -42,6 +42,9 @@ OPTIONS
the crossbar url of the coordinator
-c CONFIG, --config CONFIG
set the configuration file
-s STATE, --state STATE
set an initial state before executing a command, requires a configuration
file and strategy
-d, --debug
enable debugging
@@ -57,6 +60,12 @@ PLACE
~~~~~
This variable can be used to specify a place without using the ``-p`` option, the ``-p`` option overrides it.
STATE
~~~~~
This variable can be used to specify a state which the device transitions into
before executing a command. Requires a configuration file and a Strategy
specified for the device.
MATCHES
-------
Match patterns are used to assign a resource to a specific place. The format is:
@@ -103,6 +112,8 @@ LABGRID-CLIENT COMMANDS
``bootstrap`` Start a bootloader
``io`` Interact with Onewire devices
EXAMPLES
--------

0 comments on commit 3afe007

Please sign in to comment.