From 5f47bcd3796193af0649565e61372b87b4a59821 Mon Sep 17 00:00:00 2001 From: Stewart Date: Mon, 7 Nov 2016 22:34:21 +0000 Subject: [PATCH] Add terse documentation for pinout tool --- docs/cli_pinout.rst | 26 ++++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 27 insertions(+) create mode 100644 docs/cli_pinout.rst diff --git a/docs/cli_pinout.rst b/docs/cli_pinout.rst new file mode 100644 index 0000000..4f8950b --- /dev/null +++ b/docs/cli_pinout.rst @@ -0,0 +1,26 @@ +================== +Command-line Tools +================== + +Pinout +====== + +The gpiozero package contains a database of information about the various +revisions of Raspberry Pi. This is queried by the ``pinout`` command-line +tool to write details of the GPIO pins available. + +Unless specified, the revision of the current device will be detected. A +particular revision may be selected with the --revision command-line +option. *e.g.*: + + pinout.py --revision 000d + +By default, the output will include ANSI color codes if run in a color-capable +terminal. This behaviour may be overridden by the --color or --monochrome +options to force colored or non-colored output, respectively. *e.g.*: + + pinout.py --monochrome + +Full usage details are available with: + + pinout.py --help diff --git a/docs/index.rst b/docs/index.rst index 256db1e..c4245c4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,7 @@ Table of Contents api_tools api_pins api_exc + cli_pinout changelog license