From 5dda28559b1efed3161e582657af4f3d4596b24d Mon Sep 17 00:00:00 2001 From: Aareon Sullivan Date: Sun, 8 Jun 2025 19:33:42 -0500 Subject: [PATCH] docs: Document -R and -i flag dependency in rnstatus usage 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. --- docs/source/using.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/using.rst b/docs/source/using.rst index 73aab5d..e54d2ce 100644 --- a/docs/source/using.rst +++ b/docs/source/using.rst @@ -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] -r, --reverse reverse sorting -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 -w seconds timeout before giving up on remote queries -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 ====================