~ubuntu-branches/ubuntu/edgy/hwinfo/edgy

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): James Vega
  • Date: 2006-09-28 20:56:06 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20060928205606-bgxl69hts04xbx51
Tags: 13.4-1
* New upstream version.
* Switch from dbs to quilt
  - Revamp debian/rules
  - Add quilt and remove dbs from Build-Depends in debian/control
* Remove reference to hwscan(8) from manpage. (closes: #388245)
* Re-wrote manpage from scratch.  Drop docbook-to-man from Build-Depends.
* Remove NEWS.Debian since it is no longer applicable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
1. Usage
 
2
========
 
3
 
 
4
  hwinfo [debug=deb_flag] [log=log_file] [list[+]=hw_item] [[+|-]probe_option1] [[+|-]probe_option2] ...
 
5
 
 
6
Examples:
 
7
 
 
8
  hwinfo
 
9
    - probes for nearly everything
 
10
 
 
11
  hwinfo +all
 
12
    - probes for everything
 
13
 
 
14
  hwinfo log=hw_log
 
15
    - default probing, output is written to hw_log
 
16
      *** Please don't use "hwinfo >some_log 2>&1" to store the output into a
 
17
      log file! ***
 
18
 
 
19
  hwinfo -all +ide
 
20
    - probe for ide drives only
 
21
 
 
22
  hwinfo +all -isapnp -floppy
 
23
    - probe for everything *except* isapnp and floppies
 
24
 
 
25
Some probing flags do not stand for complete modules but enable additional
 
26
features; e.g. "pci.range" or "cdrom.info".
 
27
 
 
28
Example:
 
29
  hwinfo -all +cdrom
 
30
  gives a list of all cdrom's
 
31
 
 
32
  hwinfo -all +cdrom.info
 
33
  additionally reads the iso9660 info
 
34
 
 
35
To get a list of all supported probing flags, call 'hwinfo -all'.
 
36
 
 
37
 
 
38
2. Environment variables/kernel cmdline parameters
 
39
==================================================
 
40
 
 
41
You can control the hardware probing using the environment variable
 
42
"hwprobe" and the kernel cmdline parameters "hwprobe" & "x11".
 
43
 
 
44
If "hwprobe" is set on the kernel cmdline, the environment variable
 
45
"hwprobe" is ignored. Otherwise, the meaning of both is exactly the same.
 
46
 
 
47
  x11
 
48
    - Controls the X server/X version to prefer. It is either "3" or "4" or the
 
49
      name of the X server/X server module to use (XF3: server name without
 
50
      the leading "XF86_", XF4: the server module name).
 
51
 
 
52
      Examples:
 
53
        x11=3
 
54
          o prefer XFree86 3.x over 4.x (if possible)
 
55
 
 
56
        x11=SVGA
 
57
          o use the XF86_SVGA server (*** Even if the server does not
 
58
            support the card! ***)
 
59
 
 
60
        x11=nv
 
61
          o use the XF4 nv_drv.o driver (*** Even if the module does not
 
62
            support the card! ***)
 
63
 
 
64
  hwprobe
 
65
    - Controls which probing flags should *always* be set/cleared. (These
 
66
      settings *cannot* be overridden by command line switches.)
 
67
 
 
68
      Examples:
 
69
        hwprobe=-isapnp
 
70
          o *never* do any isapnp probing
 
71
 
 
72
        hwprobe=-braille,-modem
 
73
          o don't look for braille displays & modems
 
74
 
 
75
    - Allows you to add and remove hardware from the probing results. In this case
 
76
      the syntax is (-: remove, +: add at end of list, <nothing>: add at begin of
 
77
      list):
 
78
        hwprobe=[+-]<device_class>:<vendor_id>:<device_id>[:<unix_device_file>]
 
79
 
 
80
      <device_class>, <vendor_id> and <device_id> are device ids as used by libhd.
 
81
      See the output of hwinfo for examples. In connection with "-", you can use
 
82
      "*" as a placeholder that matches every id.
 
83
 
 
84
      Note: <unix_device_file> is optional.
 
85
 
 
86
      Note2: you cannot usefully *add* hardware that needs more info than that
 
87
      given by the hwprobe entry. Disks & floppies are notable examples.
 
88
      (But you can *remove* them.)
 
89
 
 
90
      Here is a typical hwinfo output for a mouse, with the relevant ids
 
91
      underlined (<device_class> is the combined base_class & sub_class),
 
92
      [see 1st example below]:
 
93
 
 
94
        14: PS/2 00.0: 10500 PS/2 Mouse
 
95
                       ^^^^^ -->        <device_class>
 
96
          [Created at mouse.110]
 
97
          Vendor: s0200 "Unknown"
 
98
                  ^^^^^  -->            <vendor_id>
 
99
          Model: 0002 "Generic PS/2 Mouse"
 
100
                 ^^^^  -->              <device_id>
 
101
          Device File: /dev/psaux
 
102
                       ^^^^^^^^^^ -->   <unix_device_file>
 
103
          Driver Info #0:
 
104
            XFree86 Protocol: ps/2
 
105
            GPM Protocol: ps2
 
106
          Attached to: #8 (PS/2 Controller)
 
107
 
 
108
 
 
109
      Examples:
 
110
        hwprobe=+10500:s200:2:/dev/psaux
 
111
          o add a ps/2 mouse [at the end of the hardware list]
 
112
 
 
113
        hwprobe=10500:s200:2:/dev/psaux
 
114
          o add a ps/2 mouse [at the start of the hardware list, so it
 
115
            is our default mouse]
 
116
 
 
117
        hwprobe=+10b00:s5001:0:/dev/ttyS0
 
118
          o add a braille display connected to /dev/ttyS0
 
119
 
 
120
        hwprobe=-10500:s200:2:/dev/psaux
 
121
          o remove ps/2 mice attached to /dev/psaux
 
122
 
 
123
        hwprobe=-10500:s200:2
 
124
          o remove all ps/2 mice
 
125
 
 
126
        hwprobe=-10500:*:*
 
127
          o remove all ps/2 mice
 
128
 
 
129
        hwprobe=-*:*:*:/dev/hdc
 
130
          o remove /dev/hdc
 
131
 
 
132
        hwprobe=+401:1274:5000
 
133
          o add an ensoniq sound card
 
134
 
 
135
      Grafics cards are are slightly trickier:
 
136
 
 
137
        hwprobe=+300:1014:b7
 
138
          o add a Fire GL1 card
 
139
            Note: this way you'll get a multihead config. You'll probably
 
140
            rather want the following example.
 
141
 
 
142
        hwprobe=-300:*:*,+300:1014:b7
 
143
          o remove all graphics cards; then add a Fire GL1 card
 
144
 
 
145
        hwprobe=+400:121a:1
 
146
          o add a 3fx voodoo card (Note the class "400", not "300"!)
 
147
 
 
148
    - for more ids, see "src/ids/names.*" and "src/ids/drivers.*"
 
149