Skip to content

Commit 5f47bcd

Browse files
committed
Add terse documentation for pinout tool
1 parent 726e861 commit 5f47bcd

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/cli_pinout.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
==================
2+
Command-line Tools
3+
==================
4+
5+
Pinout
6+
======
7+
8+
The gpiozero package contains a database of information about the various
9+
revisions of Raspberry Pi. This is queried by the ``pinout`` command-line
10+
tool to write details of the GPIO pins available.
11+
12+
Unless specified, the revision of the current device will be detected. A
13+
particular revision may be selected with the --revision command-line
14+
option. *e.g.*:
15+
16+
pinout.py --revision 000d
17+
18+
By default, the output will include ANSI color codes if run in a color-capable
19+
terminal. This behaviour may be overridden by the --color or --monochrome
20+
options to force colored or non-colored output, respectively. *e.g.*:
21+
22+
pinout.py --monochrome
23+
24+
Full usage details are available with:
25+
26+
pinout.py --help

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Table of Contents
1818
api_tools
1919
api_pins
2020
api_exc
21+
cli_pinout
2122
changelog
2223
license
2324

0 commit comments

Comments
 (0)