Skip to content

Commit

Permalink
Merge pull request labgrid-project#1101 from Emantor/docs/cli
Browse files Browse the repository at this point in the history
usage: document labgrid-client allow
  • Loading branch information
jluebbe authored Mar 14, 2023
2 parents 5f46217 + df1d87a commit 594be48
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -866,3 +866,25 @@ labgrid contains some command line tools which are used for remote access to
resources.
See :doc:`man/client`, :doc:`man/device-config` and :doc:`man/exporter` for
more information.

Advanced CLI features
~~~~~~~~~~~~~~~~~~~~~

This section of the manual describes advanced features that are supported by the
labgrid client CLI.

Sharing a place with a co-worker
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Labgrid client allows multiple people to access the same shared place,
even though locks can only be acquired by one person. To allow a coworker to use
a place use the ``allow`` command of labgrid client in conjunction with the
coworkers ``user`` and ``hostname``. As an example, with a places named
``example``, a user name ``john`` and a host named ``sirius``, the command looks
like this:

.. code-block:: bash
$ labgrid-client -p example allow sirius/john
To remove the allow it is currently necessary to unlock and lock the place.

0 comments on commit 594be48

Please sign in to comment.