Sync usage with man page.
[netbsd-mini2440.git] / share / man / man5 / gpio.conf.5
bloba5b0d9ffba114c60f05ea81e1967c1affe90de02
1 .\"        $NetBSD: gpio.conf.5,v 1.1 2009/07/25 16:20:11 mbalmer Exp $
2 .\"
3 .\" Copyright (c) 2009 Marc Balmer <marc@msys.ch>
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .Dd August 1, 2009
27 .Dt GPIO.CONF 5
28 .Os
29 .Sh NAME
30 .Nm gpio.conf
31 .Nd GPIO config file
32 .Sh DESCRIPTION
33 The
34 .Nm
35 file is read by the
36 .Pa gpio
37 rc.d script during system start-up and shutdown,
38 and is intended for configuring GPIO pins.
39 .Ss FILE FORMAT
40 Lines starting with a hash
41 .Pq Sq #
42 and empty lines are ignored.
43 All other lines are passed to
44 .Xr gpioctl 8 .
45 .Sh FILES
46 .Bl -tag -width XXetcXgpioXconfXX
47 .It Pa /etc/gpio.conf
48 The
49 .Nm
50 configuration file resides in
51 .Pa /etc .
52 .It Pa /etc/rc.d/gpio
53 .Xr rc.d 8
54 script that parses
55 .Nm .
56 .El
57 .Sh EXAMPLES
58 In this example, if the
59 .Pa /etc/gpio.conf
60 config file is present pin 1 of
61 .Pa /dev/gpio0
62 is set as output and named "error_led".
63 .Bd -literal -offset indent
64 # Program pin 1 of /dev/gpio0 as output and name it "error_led"
65 gpio0 1 set out error_led
66 .Ed
67 .Sh SEE ALSO
68 .Xr gpioctl 8 ,
69 .Xr rc 8