Return to fw_install.8 CVS log

Up to [local] / openbsd / fw_update

Annotation of openbsd/fw_update/fw_install.8, Revision 1.7

1.1       afresh1     1: .\" $OpenBSD$
                      2: .\"
                      3: .\" Copyright (c) 2021 Andrew Hewus Fresh <afresh1@openbsd.org>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
1.7     ! afresh1    17: .Dd $Mdocdate: December 24 2021 $
1.1       afresh1    18: .Dt FW_INSTALL 8
                     19: .Os
                     20: .Sh NAME
                     21: .Nm fw_install
                     22: .Nd download and install non-free firmware packages
                     23: .Sh SYNOPSIS
                     24: .Nm
1.7     ! afresh1    25: .Op Fl d | D
1.5       afresh1    26: .Op Fl av
1.6       afresh1    27: .Op Fl p Ar path
1.1       afresh1    28: .Op Ar driver | file ...
                     29: .Sh DESCRIPTION
                     30: The
                     31: .Nm
                     32: utility downloads and installs non-free firmware packages.
                     33: It is designed as a version of
                     34: .Xr fw_update 1
                     35: that can run in the limited environment of the installer.
                     36: .Pp
                     37: The options are as follows:
                     38: .Bl -tag -width Ds
1.5       afresh1    39: .It Fl a
                     40: Detect firmware to be installed or deleted.
                     41: Cannot be used when specifying names.
                     42: Automatically enabled when installing if no specific names are passed.
1.3       afresh1    43: .It Fl d
                     44: Delete the specified firmware.
                     45: Required additional arguments are a list of full package or driver names.
1.1       afresh1    46: .It Fl D
                     47: Download firmware packages to the current working directory,
                     48: without installing them.
1.6       afresh1    49: .It Fl p Ar path
                     50: Use the firmware found at package repository
                     51: .Ar path ,
                     52: being either a local directory or a URL,
                     53: instead of the default location.
1.2       afresh1    54: .It Fl v
                     55: Enable verbose mode.
1.4       afresh1    56: .El
1.1       afresh1    57: .Pp
                     58: Additional arguments are taken as
                     59: device names for which filenames will be looked up
                     60: or as filenames of firmware packages to be installed.
                     61: If no additional arguments are given,
                     62: .Nm
                     63: searches
                     64: .Xr dmesg 8
                     65: for
                     66: .Pa firmware_patterns
                     67: to find matching drivers.
                     68: .Sh ENVIRONMENT
                     69: .Bl -tag -width DESTDIRXXX
                     70: .It Ev DESTDIR
                     71: The root of the system to install into.
                     72: .El
                     73: .Sh FILES
                     74: .Bl -tag -width Ds
                     75: .It Pa ${DESTDIR}/usr/share/misc/firmware_patterns
                     76: A list of patterns used to detect needed firmware from the
                     77: .Xr dmesg 8 .
                     78: .It Pa ${DESTDIR}/etc/signify/openbsd-XX-fw.pub
                     79: Used with
                     80: .Xr signify 1
                     81: to verify downloaded firmware files.
                     82: .El
                     83: .Sh EXIT STATUS
                     84: .Ex -std
                     85: .\" .Sh EXAMPLES
                     86: .Sh SEE ALSO
                     87: .Xr fw_update 1 ,
                     88: .Xr dmesg 8
                     89: .\" .Sh STANDARDS
                     90: .Sh AUTHORS
                     91: The
                     92: .Nm
                     93: program was designed and written by
                     94: .An Andrew Hewus Fresh Aq Mt afresh1@openbsd.org
                     95: as a limited version of
                     96: .Xr fw_update 1 .
                     97: .\" .Sh CAVEATS