Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2025-07-22 14:31:00 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Document -R and -i flag dependency in rnstatus usage

Browse source 
Add usage example and clarify that -R requires -i flag for remote
transport instance status queries. Fixes confusion where users get
"expected str, bytes or os.PathLike object, not NoneType" error
when using -R without -i.

- Add remote status query example to Usage Examples section
- Update -R flag description to indicate -i requirement
- Add explanatory note about management identity authorization

Addresses user reported issue where documentation was unclear about
mandatory flag combination for remote management functionality.
This commit is contained in:
Aareon Sullivan 2025-06-08 19:33:42 -05:00 • committed by GitHub
parent 799bcfc7aa
commit 5dda28559b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/source/using.rst
View file

@ -355,12 +355,15 @@ Filter output to only show some interfaces:
-s SORT, --sort SORT sort interfaces by [rate, traffic, rx, tx, announces, arx, atx, held] -s SORT, --sort SORT sort interfaces by [rate, traffic, rx, tx, announces, arx, atx, held]
-r, --reverse reverse sorting -r, --reverse reverse sorting
-j, --json output in JSON format -j, --json output in JSON format
-R hash transport identity hash of remote instance to get status from -R hash transport identity hash of remote instance to get status from (requires -i)
-i path path to identity used for remote management -i path path to identity used for remote management
-w seconds timeout before giving up on remote queries -w seconds timeout before giving up on remote queries
-v, --verbose -v, --verbose
.. note::
When using ``-R`` to query a remote transport instance, you must also specify ``-i`` with the path to a management identity file that is authorized for remote management on the target system.
The rnid Utility The rnid Utility
==================== ====================