Skip to content

Commit 594be48

Browse files
authored
Merge pull request labgrid-project#1101 from Emantor/docs/cli
usage: document labgrid-client allow
2 parents 5f46217 + df1d87a commit 594be48

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

doc/usage.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -866,3 +866,25 @@ labgrid contains some command line tools which are used for remote access to
866866
resources.
867867
See :doc:`man/client`, :doc:`man/device-config` and :doc:`man/exporter` for
868868
more information.
869+
870+
Advanced CLI features
871+
~~~~~~~~~~~~~~~~~~~~~
872+
873+
This section of the manual describes advanced features that are supported by the
874+
labgrid client CLI.
875+
876+
Sharing a place with a co-worker
877+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
878+
879+
Labgrid client allows multiple people to access the same shared place,
880+
even though locks can only be acquired by one person. To allow a coworker to use
881+
a place use the ``allow`` command of labgrid client in conjunction with the
882+
coworkers ``user`` and ``hostname``. As an example, with a places named
883+
``example``, a user name ``john`` and a host named ``sirius``, the command looks
884+
like this:
885+
886+
.. code-block:: bash
887+
888+
$ labgrid-client -p example allow sirius/john
889+
890+
To remove the allow it is currently necessary to unlock and lock the place.

0 commit comments

Comments
 (0)