version 1.7, 2021/12/24 02:36:13 |
version 1.9, 2021/12/26 18:08:53 |
|
|
.\" $OpenBSD$ |
.\" $OpenBSD$ |
.\" |
.\" |
.\" Copyright (c) 2021 Andrew Hewus Fresh <afresh1@openbsd.org> |
.\" Copyright (c) 2011 Alexander Hall <alexander@beard.se> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt FW_INSTALL 8 |
.Dt FW_UPDATE 1 |
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm fw_install |
.Nm fw_update |
.Nd download and install non-free firmware packages |
.Nd install non-free firmware packages |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl d | D |
.Op Fl adinv |
.Op Fl av |
|
.Op Fl p Ar path |
.Op Fl p Ar path |
.Op Ar driver | file ... |
.Op Ar driver ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility downloads and installs non-free firmware packages. |
utility installs, updates, or deletes firmware packages for |
It is designed as a version of |
.Ar driver |
.Xr fw_update 1 |
from the Internet. |
that can run in the limited environment of the installer. |
If no |
|
.Ar driver |
|
is specified, the |
|
.Nm |
|
utility tries to determine which firmware is needed on the system. |
.Pp |
.Pp |
|
Since firmware with an acceptable license is already present in |
|
.Ox , |
|
.Nm |
|
exists purely to deal with firmware that may not be freely |
|
distributed with |
|
.Ox . |
|
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl a |
.It Fl a |
Detect firmware to be installed or deleted. |
Install or update firmware for all drivers. |
Cannot be used when specifying names. |
It is an error to specify this option with any |
Automatically enabled when installing if no specific names are passed. |
.Ar driver |
|
arguments. |
.It Fl d |
.It Fl d |
Delete the specified firmware. |
Delete firmware for |
Required additional arguments are a list of full package or driver names. |
.Ar driver . |
.It Fl D |
If used without parameters, delete all firmware that is not required by |
Download firmware packages to the current working directory, |
a driver. |
without installing them. |
If used in conjunction with |
|
.Fl a , |
|
delete firmware for all drivers. |
|
.It Fl i |
|
Display information about firmware which is installed or missing, and whether |
|
it appears to be required by a driver. |
|
.It Fl n |
|
Dry run. |
|
Do not actually install or update any firmware packages; |
|
just report the steps that would be taken. |
.It Fl p Ar path |
.It Fl p Ar path |
Use the firmware found at package repository |
Use the firmware found at package repository |
.Ar path , |
.Ar path , |
being either a local directory or a URL, |
being either a local directory or a URL, |
instead of the default location. |
instead of the default location. |
.It Fl v |
.It Fl v |
Enable verbose mode. |
Turn on verbose output. |
|
This flag can be specified multiple times for increased verbosity. |
.El |
.El |
.Pp |
.Pp |
Additional arguments are taken as |
Firmware is downloaded from release-specific directories at |
device names for which filenames will be looked up |
.Lk http://firmware.openbsd.org/firmware/ . |
or as filenames of firmware packages to be installed. |
The files are in the format required by |
If no additional arguments are given, |
.Xr pkg_add 1 , |
.Nm |
but direct use of pkg_add is discouraged. |
searches |
|
.Xr dmesg 8 |
|
for |
|
.Pa firmware_patterns |
|
to find matching drivers. |
|
.Sh ENVIRONMENT |
|
.Bl -tag -width DESTDIRXXX |
|
.It Ev DESTDIR |
|
The root of the system to install into. |
|
.El |
|
.Sh FILES |
|
.Bl -tag -width Ds |
|
.It Pa ${DESTDIR}/usr/share/misc/firmware_patterns |
|
A list of patterns used to detect needed firmware from the |
|
.Xr dmesg 8 . |
|
.It Pa ${DESTDIR}/etc/signify/openbsd-XX-fw.pub |
|
Used with |
|
.Xr signify 1 |
|
to verify downloaded firmware files. |
|
.El |
|
.Sh EXIT STATUS |
|
.Ex -std |
|
.\" .Sh EXAMPLES |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr fw_update 1 , |
.Xr pkg_add 1 , |
.Xr dmesg 8 |
.Xr dmesg 8 |
.\" .Sh STANDARDS |
|
.Sh AUTHORS |
.Sh AUTHORS |
|
.An -nosplit |
The |
The |
.Nm |
.Nm |
program was designed and written by |
program was designed by |
.An Andrew Hewus Fresh Aq Mt afresh1@openbsd.org |
.An Alexander Hall Aq Mt alexander@beard.se ; |
as a limited version of |
the current code was written by |
.Xr fw_update 1 . |
.An Marc Espie Aq Mt espie@openbsd.org . |
.\" .Sh CAVEATS |
|