source: general/sysutils/pciutils.xml@ d0d2c85a

trunk
Last change on this file since d0d2c85a was d0d2c85a, checked in by Douglas R. Reno <renodr@…>, 8 weeks ago

logrotate, pciutils, usbutils: Change the systemd units/timers to
install in /usr/lib instead of /lib, for consistency with other related
merged-/usr changes.

  • Property mode set to 100644
File size: 8.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY pciutils-download-http "&kernel-dl;/software/utils/pciutils/pciutils-&pciutils-version;.tar.xz">
8 <!ENTITY pciutils-download-ftp " ">
9 <!ENTITY pciutils-md5sum "e6e20482b4f25c5186e6a753c5edc361">
10 <!ENTITY pciutils-size "364 KB">
11 <!ENTITY pciutils-buildsize "3.8 MB">
12 <!ENTITY pciutils-time "less than 0.1 SBU">
13]>
14
15<sect1 id="pciutils" xreflabel="pciutils-&pciutils-version;">
16 <?dbhtml filename="pciutils.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>pciutils-&pciutils-version;</title>
23
24 <indexterm zone="pciutils">
25 <primary sortas="a-pciutils">pciutils</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to PCI Utils</title>
30
31 <para>
32 The <application>PCI Utils</application> package contains
33 a set of programs for listing PCI devices, inspecting
34 their status and setting their configuration registers.
35 </para>
36
37 &lfs101_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&pciutils-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&pciutils-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &pciutils-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &pciutils-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &pciutils-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &pciutils-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72<!-- Needed to update the pci-ids. systemd has a unit and timer for this,
73 but for anyone who updates this file on either platform, it's needed
74 to download the pci.ids file. -->
75
76 <bridgehead renderas="sect3">pciutils Dependencies</bridgehead>
77
78 <bridgehead renderas="sect4">Recommended</bridgehead>
79 <para role="recommended">
80 <xref linkend="curl"/>,
81 <xref linkend="wget"/>, or
82 <xref linkend="lynx"/>
83 (for the update-pciids script to function correctly).
84 </para>
85
86 <para condition="html" role="usernotes">User Notes:
87 <ulink url="&blfs-wiki;/pciutils"/>
88 </para>
89 </sect2>
90
91 <sect2 role="installation">
92 <title>Installation of PCI Utils</title>
93
94 <para>
95 Install <application>PCI Utils</application> by
96 running the following commands:
97 </para>
98
99<screen><userinput>make PREFIX=/usr \
100 SHAREDIR=/usr/share/hwdata \
101 SHARED=yes</userinput></screen>
102
103 <para>
104 This package does not come with a test suite.
105 </para>
106
107 <para>
108 Now, as the <systemitem class="username">root</systemitem> user:
109 </para>
110
111<screen role="root"><userinput>make PREFIX=/usr \
112 SHAREDIR=/usr/share/hwdata \
113 SHARED=yes \
114 install install-lib &amp;&amp;
115
116chmod -v 755 /usr/lib/libpci.so</userinput></screen>
117
118 </sect2>
119
120 <sect2 role="commands">
121 <title>Command Explanations</title>
122
123 <para>
124 <parameter>SHARED=yes</parameter>: This parameter enables building of
125 the shared library instead of the static one.
126 </para>
127
128 <para>
129 <option>ZLIB=no</option>: This option prevents compression of
130 the <filename>pci.ids</filename> file.
131 </para>
132
133 </sect2>
134
135 <sect2 role="configuration">
136 <title>Configuring PCI Utils</title>
137
138 <para>
139 The <filename>pci.ids</filename> data file is constantly being
140 updated. To get a current version of this file, run
141 <command>update-pciids</command> as the <systemitem
142 class="username">root</systemitem> user. This program requires the
143 <xref linkend="which"/> script or program to find <xref linkend="curl"/>,
144 <xref linkend="lynx"/> or <xref linkend="wget"/> which are used to
145 download the most current file, and then replace the existing file in
146 <filename class="directory">/usr/share/hwdata</filename>.
147 </para>
148
149 <para>
150 You should update the <filename>/usr/share/hwdata/pci.ids</filename> file
151 periodically. <phrase revision="sysv">If you've installed
152 <xref linkend="fcron"/> and completed the section on periodic jobs,
153 execute</phrase><phrase revision="systemd">Execute</phrase> the following
154 commands, as the <systemitem class="username">root</systemitem> user,
155 to create a <phrase revision="sysv">weekly cron job:</phrase>
156 <phrase revision="systemd">systemd timer to update it weekly on Sundays
157 at 2:30 A.M. (local time):</phrase>
158 </para>
159
160<screen role="nodump" revision="sysv"><userinput>cat &gt; /etc/cron.weekly/update-pciids.sh &lt;&lt; "EOF" &amp;&amp;
161<literal>#!/bin/bash
162/usr/sbin/update-pciids</literal>
163EOF
164chmod 754 /etc/cron.weekly/update-pciids.sh</userinput></screen>
165
166<screen role="root" revision="systemd"><userinput>cat &gt; /usr/lib/systemd/system/update-pciids.service &lt;&lt; "EOF" &amp;&amp;
167<literal>[Unit]
168Description=Update pci.ids file
169Documentation=man:update-pciids(8)
170DefaultDependencies=no
171After=local-fs.target network-online.target
172Before=shutdown.target
173
174[Service]
175Type=oneshot
176RemainAfterExit=yes
177ExecStart=/usr/sbin/update-pciids</literal>
178EOF
179cat &gt; /usr/lib/systemd/system/update-pciids.timer &lt;&lt; "EOF" &amp;&amp;
180<literal>[Unit]
181Description=Update pci.ids file weekly
182
183[Timer]
184OnCalendar=Sun 02:30:00
185Persistent=true
186
187[Install]
188WantedBy=timers.target</literal>
189EOF
190systemctl enable update-pciids.timer</userinput></screen>
191
192
193 </sect2>
194
195 <sect2 role="content">
196 <title>Contents</title>
197
198 <segmentedlist>
199 <segtitle>Installed Programs</segtitle>
200 <segtitle>Installed Library</segtitle>
201 <segtitle>Installed Directory</segtitle>
202
203 <seglistitem>
204 <seg>
205 lspci, setpci, and update-pciids
206 </seg>
207 <seg>
208 libpci.so
209 </seg>
210 <seg>
211 /usr/include/pci and /usr/share/hwdata
212 </seg>
213 </seglistitem>
214 </segmentedlist>
215
216 <variablelist>
217 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
218 <?dbfo list-presentation="list"?>
219 <?dbhtml list-presentation="table"?>
220
221 <varlistentry id="lspci">
222 <term><command>lspci</command></term>
223 <listitem>
224 <para>
225 is a utility for displaying information about all PCI buses
226 in the system and all devices connected to them
227 </para>
228 <indexterm zone="pciutils lspci">
229 <primary sortas="b-lspci">lspci</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="setpci">
235 <term><command>setpci</command></term>
236 <listitem>
237 <para>
238 is a utility for querying and configuring PCI devices
239 </para>
240 <indexterm zone="pciutils setpci">
241 <primary sortas="b-setpci">setpci</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="update-pciids">
247 <term><command>update-pciids</command></term>
248 <listitem>
249 <para>
250 fetches the current version of the PCI ID list. <!-- Requires
251 <xref linkend="curl"/>, <xref linkend="lynx"/> or
252 <xref linkend="wget"/>.
253 -->
254 </para>
255 <indexterm zone="pciutils update-pciids">
256 <primary sortas="b-update-pciids">update-pciids</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="libpci">
262 <term><filename class="libraryfile">libpci.so</filename></term>
263 <listitem>
264 <para>
265 is library that allows applications to access the PCI
266 subsystem
267 </para>
268 <indexterm zone="pciutils libpci">
269 <primary sortas="c-libpci">libpci.so</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 </variablelist>
275
276 </sect2>
277
278</sect1>
Note: See TracBrowser for help on using the repository browser.