summaryrefslogtreecommitdiffstats
path: root/usr.sbin/pccard/pccardc
diff options
context:
space:
mode:
authorsheldonh <sheldonh@FreeBSD.org>2000-10-05 07:18:59 +0000
committersheldonh <sheldonh@FreeBSD.org>2000-10-05 07:18:59 +0000
commit8deb3ff4ab0ce7300b2a20b6a51cbbe2e3de97d6 (patch)
tree0ffca1612e04881085c5adedc1ee04eab554a896 /usr.sbin/pccard/pccardc
parentda9b1783beb272561640b24a0deec5ee692bcaf4 (diff)
downloadFreeBSD-src-8deb3ff4ab0ce7300b2a20b6a51cbbe2e3de97d6.zip
FreeBSD-src-8deb3ff4ab0ce7300b2a20b6a51cbbe2e3de97d6.tar.gz
Fix abuse of the Pa, Nm and Ar macros. This necessitated a rewording
of the description for the "power" internal command. Reviewed by: sanpei
Diffstat (limited to 'usr.sbin/pccard/pccardc')
-rw-r--r--usr.sbin/pccard/pccardc/pccardc.874
1 files changed, 39 insertions, 35 deletions
diff --git a/usr.sbin/pccard/pccardc/pccardc.8 b/usr.sbin/pccard/pccardc/pccardc.8
index 32ed619..38bb8ef 100644
--- a/usr.sbin/pccard/pccardc/pccardc.8
+++ b/usr.sbin/pccard/pccardc/pccardc.8
@@ -44,47 +44,50 @@ controls PC-CARD slots and configures and displays information about PCMCIA card
understands the following subcommands:
.Pp
.Bl -tag -width pccardmem -compact
-.It Pa beep
+.It Ic beep
Set beep type
-.It Pa dumpcis
+.It Ic dumpcis
Print card CIS(s)
-.It Pa enabler
+.It Ic enabler
Device driver enabler
-.It Pa help
+.It Ic help
Print command summary
-.It Pa pccardmem
+.It Ic pccardmem
Allocate memory for pccard driver
-.It Pa power
+.It Ic power
Power on/off slots
-.It Pa rdattr
+.It Ic rdattr
Read attribute memory
-.It Pa rdmap
+.It Ic rdmap
Read pcic mappings
-.It Pa rdreg
+.It Ic rdreg
Read pcic register
-.It Pa wrattr
+.It Ic wrattr
Write byte to attribute memory
-.It Pa wrreg
+.It Ic wrreg
Write pcic register
.El
.Bl -enum
.It
-.Nm beep Ar 0|1
+.Ic beep Ar beep_mode
.Pp
Specifies the sound made upon card insertion or removal.
This subcommand corresponds to
-.Pa pccard_beep
+.Va pccard_beep
in
.Xr rc.conf 5 .
+Allowed values for
+.Ar beep_mode
+are:
.Pp
.Bl -tag -width Ds -compact
-.It Ar 0
+.It Li 0
silent mode
-.It Ar 1
+.It Li 1
simple beep mode
.El
.It
-.Nm dumpcis
+.Ic dumpcis
.Op Ar slot
.Pp
Displays
@@ -95,7 +98,7 @@ specifies which slot to read.
When no option is supplied, it displays
the CIS of all of the available cards.
.It
-.Nm enabler Ar slot driver
+.Ic enabler Ar slot driver
.Op Fl m Ar card addr size
.Op Fl a Ar iobase
.Op Fl i Ar irq
@@ -139,12 +142,12 @@ This allows use of some unrecognized cards with broken CIS tuples,
and is also useful for testing a card that has not yet reported.
However, beware that it frequently cannot recognize new cards properly.
.It
-.Nm help
+.Ic help
.Pp
Prints help for
.Nm pccardc .
.It
-.Nm pccardmem Ar addr
+.Ic pccardmem Ar addr
.Pp
Specifies the host address using PC-CARD controller(PCIC)
will use to map cards to.
@@ -164,27 +167,28 @@ you can only use the following four addresses:
.Pp
You can use "DEFAULT" instead of 0xd0000.
This subcommand corresponds to
-.Pa pccard_mem
+.Va pccard_mem
in
.Xr rc.conf 5 .
.It
-.Nm power Ar slot 0|1
+.Ic power Ar slot power_mode
.Pp
-It turns ON/OFF a power supply of a card in the slot specified in
-.Ar slot .
+Changes the state of the power supply of the card in the specified
+.Ar slot :
.Pp
.Bl -tag -width Ds
-.It Ar 0
-turn OFF a power supply.
+.It Li 0
+Turn off a power supply.
If a card becomes unstable when it is removed at
activate state,
-this can force it to turn into inactive state first and remove it safely.
-.It Ar 1
-turn ON a power supply and into active state similar to a card insertion.
+this can force it into inactive state first and remove it safely.
+.It Li 1
+Turn on a power supply and set it into active state
+(similar to a card insertion).
.El
.Pp
.It
-.Nm rdattr Ar slot offs length
+.Ic rdattr Ar slot offs length
.Pp
Prints a hex dump
.Ar length
@@ -194,7 +198,7 @@ starting at
.Ar offs .
All parameters are in hex.
.It
-.Nm rdmap
+.Ic rdmap
.Op Ar slot
.Pp
Displays where the four memory windows and two I/O windows of a PC-CARD slot
@@ -203,14 +207,14 @@ If
.Ar slot
is not supplied, it displays the information for all of slots in the system.
.It
-.Nm rdreg
+.Ic rdreg
.Op Ar slot
.Pp
Displays the 64 registers of the card in
.Ar slot
(all slots by default).
.It
-.Nm wrattr Ar slot offs value
+.Ic wrattr Ar slot offs value
.Pp
Writes a single byte to the card's EEPROM at
an offset address from the top specified in
@@ -221,7 +225,7 @@ with a value specified in
(hex).
This is preserved after the card is removed.
.It
-.Nm wrreg Ar slot reg value
+.Ic wrreg Ar slot reg value
.Pp
Writes a register of a PC-CARD.
Specify a PC-CARD slot number in
@@ -251,7 +255,7 @@ This man page was written by
.An Toshihiko ARAI Aq toshi@jp.FreeBSD.org .
.Sh BUGS
Be careful when using
-.Nm enabler
+.Ic enabler
and
-.Nm wrattr .
+.Ic wrattr .
Misuse can make the system unstable or damage the card.
OpenPOWER on IntegriCloud