Return to fw_install.8 CVS log

Up to [local] / openbsd / fw_update

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

1.9       afresh1     1: .\" $OpenBSD: fw_update.1,v 1.5 2020/07/24 16:40:47 jmc Exp $
1.1       afresh1     2: .\"
1.9       afresh1     3: .\" Copyright (c) 2011 Alexander Hall <alexander@beard.se>
1.1       afresh1     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.10    ! afresh1    17: .Dd $Mdocdate: December 26 2021 $
        !            18: .Dt FW_UPDATE 8
1.1       afresh1    19: .Os
                     20: .Sh NAME
1.9       afresh1    21: .Nm fw_update
                     22: .Nd install non-free firmware packages
1.1       afresh1    23: .Sh SYNOPSIS
                     24: .Nm
1.10    ! afresh1    25: .Op Fl adDnv
1.6       afresh1    26: .Op Fl p Ar path
1.10    ! afresh1    27: .Op Ar driver | file ...
1.1       afresh1    28: .Sh DESCRIPTION
                     29: The
                     30: .Nm
1.9       afresh1    31: utility installs, updates, or deletes firmware packages for
                     32: .Ar driver
                     33: from the Internet.
                     34: If no
                     35: .Ar driver
                     36: is specified, the
                     37: .Nm
                     38: utility tries to determine which firmware is needed on the system.
                     39: .Pp
                     40: Since firmware with an acceptable license is already present in
                     41: .Ox ,
                     42: .Nm
                     43: exists purely to deal with firmware that may not be freely
                     44: distributed with
                     45: .Ox .
1.1       afresh1    46: .Pp
                     47: The options are as follows:
                     48: .Bl -tag -width Ds
1.5       afresh1    49: .It Fl a
1.9       afresh1    50: Install or update firmware for all drivers.
                     51: It is an error to specify this option with any
                     52: .Ar driver
                     53: arguments.
1.10    ! afresh1    54: This is enabled by default unless drivers, files or
        !            55: .Fl d
        !            56: are specified.
1.3       afresh1    57: .It Fl d
1.9       afresh1    58: Delete firmware for
                     59: .Ar driver .
                     60: If used without parameters, delete all firmware that is not required by
                     61: a driver.
                     62: If used in conjunction with
                     63: .Fl a ,
                     64: delete firmware for all drivers.
1.10    ! afresh1    65: .It Fl D
        !            66: Download drivers only.
        !            67: By default downloads to the current directory.
        !            68: Secifying a URL with
        !            69: .Fl p
        !            70: downloads from that URL,
        !            71: specifying a path downloads to that directory.
1.8       afresh1    72: .It Fl n
1.9       afresh1    73: Dry run.
                     74: Do not actually install or update any firmware packages;
                     75: just report the steps that would be taken.
1.6       afresh1    76: .It Fl p Ar path
                     77: Use the firmware found at package repository
                     78: .Ar path ,
                     79: being either a local directory or a URL,
                     80: instead of the default location.
1.2       afresh1    81: .It Fl v
1.9       afresh1    82: Turn on verbose output.
                     83: This flag can be specified multiple times for increased verbosity.
1.4       afresh1    84: .El
1.1       afresh1    85: .Pp
1.9       afresh1    86: Firmware is downloaded from release-specific directories at
                     87: .Lk http://firmware.openbsd.org/firmware/ .
                     88: The files are in the format required by
                     89: .Xr pkg_add 1 ,
                     90: but direct use of pkg_add is discouraged.
1.10    ! afresh1    91: .Sh ENVIRONMENT
        !            92: .Bl -tag -width DESTDIRXXX
        !            93: .It Ev DESTDIR
        !            94: The root of the system to install into.
        !            95: .El
        !            96: .Sh FILES
        !            97: .Bl -tag -width Ds
        !            98: .It Pa ${DESTDIR}/usr/share/misc/firmware_patterns
        !            99: A list of patterns used to detect needed firmware from the
        !           100: .Xr dmesg 8 .
        !           101: .It Pa ${DESTDIR}/etc/signify/openbsd-XX-fw.pub
        !           102: Used with
        !           103: .Xr signify 1
        !           104: to verify downloaded firmware files.
        !           105: .El
1.1       afresh1   106: .Sh SEE ALSO
1.9       afresh1   107: .Xr pkg_add 1 ,
1.1       afresh1   108: .Xr dmesg 8
                    109: .Sh AUTHORS
1.9       afresh1   110: .An -nosplit
1.1       afresh1   111: The
                    112: .Nm
1.9       afresh1   113: program was designed by
                    114: .An Alexander Hall Aq Mt alexander@beard.se ;
1.10    ! afresh1   115: it was then replaced with a perl version by
1.9       afresh1   116: .An Marc Espie Aq Mt espie@openbsd.org .
1.10    ! afresh1   117: It was rewritten to be able to be run from the installer by
        !           118: .An Andrew Hewus Fresh Aq Mt afresh1@openbsd.org .