Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / userconf.4
blob3b6733e7f06bee3ccf64b0f560dc81d0fde8ed59
1 .\"     $NetBSD: userconf.4,v 1.11 2003/06/27 18:51:04 wiz Exp $
2 .\"
3 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Gregory McGarry.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd July 1, 2001
31 .Dt USERCONF 4
32 .Os
33 .Sh NAME
34 .Nm userconf
35 .Nd in-kernel device configuration manager
36 .Sh SYNOPSIS
37 .Cd options USERCONF
38 .Sh DESCRIPTION
39 .Nm
40 is the in-kernel device configuration manager.
41 It is used to alter the kernel autoconfiguration framework at runtime.
42 .Nm
43 is activated from the boot loader by passing the
44 .Fl c
45 option to the kernel.
46 .Sh COMMAND SYNTAX
47 The general command syntax is:
48 .Bd -ragged -offset indent
49 .Ic command Op Ar option
50 .Ed
51 .Pp
52 .Nm
53 has a
54 .Xr more 1 Ns -like
55 functionality; if a number of lines in a command's output exceeds the
56 number defined in the lines variable, then
57 .Nm
58 displays
59 .Dq "-- more --"
60 and waits for a response, which may be one of:
61 .Bl -tag -offset indent -width "\*[Lt]return\*[Gt]"
62 .It \*[Lt]return\*[Gt]
63 one more line.
64 .It \*[Lt]space\*[Gt]
65 one more page.
66 .It Ic q
67 abort the current command, and return to the command input mode.
68 .El
69 .Sh COMMANDS
70 .Nm
71 supports the following commands:
72 .Bl -tag -width 5n
73 .It Ic lines Ar count
74 Specify the number of lines before more.
75 .It Ic base Ar 8 | 10 | 16
76 Base for displaying large numbers.
77 .It Ic change Ar devno | dev
78 Change devices.
79 .It Ic disable Ar devno | dev
80 Disable devices.
81 .It Ic enable Ar devno | dev
82 Enable devices.
83 .It Ic exit
84 A synonym for
85 .Ic quit .
86 .It Ic find Ar devno | dev
87 Find devices.
88 .It Ic help
89 Display online help.
90 .It Ic list
91 List current configuration.
92 .It Ic quit
93 Leave userconf.
94 .It Ic \&?
95 A synonym for
96 .Ic help .
97 .El
98 .Sh HISTORY
99 The
101 framework first appeared in
102 .Ox 2.0 ,
103 and was then integrated into
104 .Nx 1.6 .
105 .Sh AUTHORS
108 framework was written by
109 .An Mats O Jansson
110 .Aq moj@stacken.kth.se .