Browse Source

update the man page

Pat Beirne 2 years ago
parent
commit
d95bd9a27e
1 changed files with 13 additions and 12 deletions
  1. 13 12
      opio.1

+ 13 - 12
opio.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.9.2.1
 .\"
-.TH "OPIO" "1" "Aug 2021" "opio v1.0" ""
+.TH "" "" "" "" ""
 .hy
 .SH NAME
 .PP
@@ -8,9 +8,9 @@ opio - Control GPIO pins on OrangePi.
 A replacement for WiringPi
 .SH SYNOPSIS
 .PP
-\f[B]opio\f[R] [-2] readall
+\f[B]opio\f[R] [-2] readall {or status}
 .PP
-\f[B]opio\f[R] [-2] readallx
+\f[B]opio\f[R] [-2] readallx {or statusx}
 .PP
 \f[B]opio\f[R] [-2] exports
 .PP
@@ -36,7 +36,7 @@ Running \f[B]opio\f[R] without any parameters will show its usage.
 via `sudo'.
 .SH COMMANDS
 .TP
-\f[B]readall\f[R]
+\f[B]readall\f[R] or \f[B]status\f[R]
 Displays the state of the gpio pins in a grid format.
 The list includes all the pins used in the on-board 40 pin connector.
 For each pin, the listing shows the gpio pin number, its alternate
@@ -44,8 +44,9 @@ function, its i96 pin name, its current \f[I]mode\f[R] and
 \f[I]value\f[R], and the corresponding pin number on the 40 pin
 connector.
 .TP
-\f[B]readallx\f[R]
-Creates a similar chart, but includes the RDA pin names.
+\f[B]readallx\f[R] or \f[B]statusx\f[R]
+Creates a similar chart, but includes the RDA pin names and Linux device
+driver names.
 .TP
 \f[B]leds\f[R]
 Creates a smaller chart, for the interesting I/O pins which are
@@ -54,8 +55,8 @@ On the i96 board, there are 3 LEDs which can be controlled via
 \f[B]opio\f[R]
 .TP
 \f[B]exports\f[R]
-Print a list of entries in /sys/class/gpio, indicating which pins have
-been exported (prepared for read/write).
+Print a list of current entries in /sys/class/gpio, indicating which
+pins have been exported (prepared for read/write).
 If a gpio pin exists on the 40 pin connector, the pin number is listed.
 .TP
 \f[B]mode\f[R]
@@ -66,6 +67,7 @@ then set the direction.
 If you set the `alt' function, the export will be removed.
 With the \f[B]-d\f[R] option, the export is not created, but the
 `in'/`out'/`alt' \f[I]mode\f[R] setting will still be done.
+.IP \[bu] 2
 \f[B]mode\f[R] with a pin number and no set-mode request, will simply
 return the current \f[I]mode\f[R] (in, out, alt, in*, alt*).
 .TP
@@ -155,8 +157,9 @@ The \f[B]exports\f[R] command is always done with \f[I]high level\f[R]
 commands.
 .PP
 Be careful about making changed with the \f[B]-d\f[R] option.
-Some linux gpio drivers will direction and value, so changes you make
-with the \f[B]-d\f[R] option may not be reflected in the export folder.
+Some linux gpio drivers will cache the direction and value, so changes
+you make with the \f[B]-d\f[R] option may not be reflected in the export
+folder.
 .SH EXAMPLES
 .PP
 display a chart of the pin assignments of the 40 pin connector:
@@ -217,5 +220,3 @@ pins.
 the LCD.
 If you are using an LCD in the socket, do \f[I]not\f[R] change the mode
 on pins 38 & 40.
-.SH AUTHORS
-Pat Beirne <patb@pbeirne.com>.