~ubuntu-branches/ubuntu/saucy/biosdevname/saucy-proposed

« back to all changes in this revision

Viewing changes to biosdevname.1

  • Committer: Bazaar Package Importer
  • Author(s): Colin Watson
  • Date: 2011-02-23 17:58:36 UTC
  • Revision ID: james.westby@ubuntu.com-20110223175836-4f0cbcno9zm0lmdu
Tags: upstream-0.3.7
ImportĀ upstreamĀ versionĀ 0.3.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"                                      Hey, EMACS: -*- nroff -*-
 
2
.\" First parameter, NAME, should be all caps
 
3
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 
4
.\" other parameters are allowed: see man(7), man(1)
 
5
.TH BIOSDEVNAME 1 "Nov 28, 2010"
 
6
.\" Please adjust this date whenever revising the manpage.
 
7
.\"
 
8
.\" Some roff macros, for reference:
 
9
.\" .nh        disable hyphenation
 
10
.\" .hy        enable hyphenation
 
11
.\" .ad l      left justify
 
12
.\" .ad b      justify to both left and right margins
 
13
.\" .nf        disable filling
 
14
.\" .fi        enable filling
 
15
.\" .br        insert line break
 
16
.\" .sp <n>    insert n+1 empty lines
 
17
.\" for manpage-specific macros, see man(7)
 
18
.SH NAME
 
19
biosdevname \- give BIOS-given name of a device
 
20
.SH SYNOPSIS
 
21
.B biosdevname
 
22
.RI [options]\ [args]...
 
23
.SH DESCRIPTION
 
24
biosdevname takes a kernel device name as an
 
25
argument, and returns the BIOS-given name it "should" be.
 
26
.SH OPTIONS
 
27
.TP
 
28
.B \-i, \-\-interface
 
29
Treat [args] as ethernet devs
 
30
.TP
 
31
.B \-d, \-\-debug
 
32
Enable debugging
 
33
.TP
 
34
.B \-\-policy \fI[physical|all_ethN]
 
35
.TP
 
36
.B \-\-prefix \fI[string]
 
37
string use for embedded NICs in the physical policy (default=em)
 
38
.SH POLICIES
 
39
.br
 
40
The
 
41
.B physical
 
42
policy is the current default.  However, when invoking biosdevname in
 
43
udev rules, one should always specify the policy you want, as the
 
44
default has changed over time.
 
45
.br
 
46
The
 
47
.B physical
 
48
policy uses the following scheme:
 
49
.TP
 
50
em<port>
 
51
for embedded NICs
 
52
.TP
 
53
pci<slot>#<port>_<virtual instance>
 
54
for cards in PCI slots
 
55
.br
 
56
.TP
 
57
The
 
58
.B all_ethN
 
59
policy makes a best guess at what the device order should be, with
 
60
embedded devices first, PCI cards in ascending slot order, and ports
 
61
in ascending PCI bus/device/function order breadth-first.  However,
 
62
this policy
 
63
.I does not work
 
64
if your PCI devices are hot-plugged or hot-pluggable, including the
 
65
virtual functions on an SR-IOV device.  In a hot-plug scenario, each separate
 
66
udev instance will be invoked in parallel, while the device tree is
 
67
still being populated with new devices.  Each udev instance will see a
 
68
different PCI tree, and thus cannot provide consistent enumeration.
 
69
Use of this policy should be limited to only scenarios where all PCI
 
70
devices are present at boot (cold-plug).
 
71
 
 
72
.SH EXIT CODES
 
73
Returns 0 on success, with BIOS-suggested name printed to stdout.
 
74
.br
 
75
Returns 1 on provided device name lookup failure.
 
76
.br
 
77
Returns 2 if system BIOS does not provide naming information.
 
78
biosdevname requires system BIOS to provide naming information, either
 
79
via SMBIOS or sysfs files.
 
80
.br
 
81
Returns 3 if not run as root but requires root privileges.
 
82
.br
 
83
Returns 4 if running in a virtual machine.
 
84
 
 
85
.SH SEE ALSO
 
86
.br
 
87
http://linux.dell.com/wiki/index.php/Oss/libnetdevname
 
88
.br
 
89
http://linux.dell.com/files/biosdevname/
 
90
.br
 
91
git://linux.dell.com/biosdevname.git
 
92
 
 
93
.sh RELATED PROGRAMS
 
94
.br
 
95
The
 
96
.B dmidecode
 
97
package contains two tools useful for debugging BIOS features that
 
98
biosdevname uses, specifically
 
99
.B dmidecode
 
100
to read the SMBIOS Type 9 and Type 41 tables, and
 
101
.B biosdecode
 
102
to read the PCI IRQ Routing Table.  Please include the output of each
 
103
of these programs in any bug reports.
 
104
.SH AUTHOR
 
105
biosdevname was written by  Matt Domsch <Matt_Domsch@dell.com>
 
106
.PP
 
107
This manual page was written by Rudy Gevaert <Rudy.Gevaert@UGent.be>,
 
108
for the Debian project (but may be used by others).