diff doc/Rvinterf-tools @ 762:ad503b495e3e

doc/Rvinterf-tools: document rvinterf -b PID addition
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 02 Dec 2020 20:17:23 +0000
parents 5b88ba62b9ae
children 71edc12b1aa7
line wrap: on
line diff
--- a/doc/Rvinterf-tools	Wed Dec 02 19:49:23 2020 +0000
+++ b/doc/Rvinterf-tools	Wed Dec 02 20:17:23 2020 +0000
@@ -66,7 +66,12 @@
 
 The following options have the same meaning as in rvtdump, see the rvtdump
 section above for the details: -b, -B, -d and -l.  The only difference is that
--b without -l is potentially useful and thus allowed.
+-b without -l is potentially useful and thus allowed.  Additionally rvinterf -b
+records the PID of the backgrounded process in /tmp/rvinterf.pid (inability to
+write to this file produces a non-fatal warning); the intended use case is for
+scripts that run rvinterf -b (perhaps as fc-xram secondary program with the FFS
+editor application), perform some fc-fsio or other manipulations, and then kill
+the backgrounded rvinterf process.
 
 Additional rvinterf options which don't exist in rvtdump are:
 
@@ -91,7 +96,7 @@
 
 	This option is not meant for direct use by human users.  It is passed
 	by "client" programs when they invoke rvinterf behind the scenes with
-	an unnamed and unbound socket pair instead of conecting to an already-
+	an unnamed and unbound socket pair instead of connecting to an already-
 	running rvinterf instance.
 
 -w number_in_seconds