u-boot/doc/usage/cmd/wget.rst
Heinrich Schuchardt 159dbe1fb1 doc: improve wget man-page
* correct formatting of synopsis
* improve description of TCP SACK configuration

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-12-29 10:51:50 +01:00

62 lines
1.3 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
wget command
============
Synopsis
--------
::
wget address [[hostIPaddr:]path]
Description
-----------
The wget command is used to download a file from an HTTP server.
wget command will use HTTP over TCP to download files from an HTTP server.
Currently it can only download image from an HTTP server hosted on port 80.
address
memory address for the data downloaded
hostIPaddr
IP address of the HTTP server, defaults to the value of environment
variable *serverip*
path
path of the file to be downloaded.
Example
-------
In the example the following steps are executed:
* setup client network address
* download a file from the HTTP server
::
=> setenv autoload no
=> dhcp
BOOTP broadcast 1
*** Unhandled DHCP Option in OFFER/ACK: 23
*** Unhandled DHCP Option in OFFER/ACK: 23
DHCP client bound to address 192.168.1.105 (210 ms)
=> wget ${loadaddr} 192.168.1.254:/index.html
HTTP/1.0 302 Found
Packets received 4, Transfer Successful
Configuration
-------------
The command is only available if CONFIG_CMD_WGET=y.
TCP Selective Acknowledgments can be enabled via CONFIG_PROT_TCP_SACK=y.
This will improve the download speed.
Return value
------------
The return value $? is 0 (true) on success and 1 (false) otherwise.