| 1 | // /**
|
|---|
| 2 | //
|
|---|
| 3 | // (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
|
|---|
| 4 | // Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved. <BR>
|
|---|
| 5 | // SPDX-License-Identifier: BSD-2-Clause-Patent
|
|---|
| 6 | //
|
|---|
| 7 | // Module Name:
|
|---|
| 8 | //
|
|---|
| 9 | // Tftp.uni
|
|---|
| 10 | //
|
|---|
| 11 | // Abstract:
|
|---|
| 12 | //
|
|---|
| 13 | // String definitions for UEFI Shell TFTP command
|
|---|
| 14 | //
|
|---|
| 15 | //
|
|---|
| 16 | // **/
|
|---|
| 17 |
|
|---|
| 18 | /=#
|
|---|
| 19 |
|
|---|
| 20 | #langdef en-US "english"
|
|---|
| 21 |
|
|---|
| 22 | #string STR_GEN_TOO_MANY #language en-US "%H%s%N: Too many arguments\r\n"
|
|---|
| 23 | #string STR_GEN_TOO_FEW #language en-US "%H%s%N: Too few arguments\r\n"
|
|---|
| 24 | #string STR_GEN_PARAM_INV #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"
|
|---|
| 25 | #string STR_GEN_PROBLEM #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
|
|---|
| 26 | #string STR_GEN_FILE_OPEN_FAIL #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"
|
|---|
| 27 | #string STR_GEN_CRLF #language en-US "\r\n"
|
|---|
| 28 |
|
|---|
| 29 | #string STR_TFTP_ERR_NO_NIC #language en-US "No network interface card found.\r\n"
|
|---|
| 30 | #string STR_TFTP_ERR_NIC_NAME #language en-US "Failed to get the name of the network interface card number %d - %r\r\n"
|
|---|
| 31 | #string STR_TFTP_ERR_OPEN_PROTOCOL #language en-US "Unable to open MTFTP4 protocol on '%H%s%N' - %r\r\n"
|
|---|
| 32 | #string STR_TFTP_ERR_CONFIGURE #language en-US "Unable to configure MTFTP4 protocol on '%H%s%N' - %r\r\n"
|
|---|
| 33 | #string STR_TFTP_ERR_FILE_SIZE #language en-US "Unable to get the size of the file '%H%s%N' on '%H%s%N' - %r\r\n"
|
|---|
| 34 | #string STR_TFTP_ERR_DOWNLOAD #language en-US "Unable to download the file '%H%s%N' on '%H%s%N' - %r\r\n"
|
|---|
| 35 | #string STR_TFTP_ERR_WRITE #language en-US "Unable to write into file '%H%s%N' - %r\r\n"
|
|---|
| 36 | #string STR_TFTP_ERR_NIC_NOT_FOUND #language en-US "Network Interface Card '%H%s%N' not found.\r\n"
|
|---|
| 37 | #string STR_TFTP_DOWNLOADING #language en-US "Downloading the file '%H%s%N'\r\n"
|
|---|
| 38 | #string STR_TFTP_STRING #language en-US "%s"
|
|---|
| 39 |
|
|---|
| 40 | #string STR_GET_HELP_TFTP #language en-US ""
|
|---|
| 41 | ".TH tftp 0 "Download a file from TFTP server."\r\n"
|
|---|
| 42 | ".SH NAME\r\n"
|
|---|
| 43 | "Download a file from TFTP server.\r\n"
|
|---|
| 44 | ".SH SYNOPSIS\r\n"
|
|---|
| 45 | " \r\n"
|
|---|
| 46 | "TFTP [-i interface] [-l <port>] [-r <port>] [-c <retry count>] [-t <timeout>]\r\n"
|
|---|
| 47 | " [-s <block size>] [-w <window size>] host remotefilepath [localfilepath]\r\n"
|
|---|
| 48 | ".SH OPTIONS\r\n"
|
|---|
| 49 | " \r\n"
|
|---|
| 50 | " -i interface - Specifies an adapter name, i.e., eth0.\r\n"
|
|---|
| 51 | " -l port - Specifies the local port number. Default value is 0\r\n"
|
|---|
| 52 | " and the port number is automatically assigned.\r\n"
|
|---|
| 53 | " -r port - Specifies the remote port number. Default value is 69.\r\n"
|
|---|
| 54 | " -c <retry count> - The number of times to transmit request packets and\r\n"
|
|---|
| 55 | " wait for a response. The default value is 6. Set to zero\r\n"
|
|---|
| 56 | " also means to use the default value.\r\n"
|
|---|
| 57 | " -t <timeout> - The number of seconds to wait for a response after\r\n"
|
|---|
| 58 | " sending a request packet. Default value is 4s.\r\n"
|
|---|
| 59 | " -s <block size> - Specifies the TFTP blksize option as defined in RFC 2348.\r\n"
|
|---|
| 60 | " Valid range is between 8 and 65464, default value is 512.\r\n"
|
|---|
| 61 | " -w <window size> - Specifies the TFTP windowsize option as defined in RFC 7440.\r\n"
|
|---|
| 62 | " Valid range is between 1 and 64, default value is 1.\r\n"
|
|---|
| 63 | " host - Specify TFTP Server IPv4 address.\r\n"
|
|---|
| 64 | " remotefilepath - TFTP server file path to download the file.\r\n"
|
|---|
| 65 | " localfilepath - Local destination file path.\r\n"
|
|---|
| 66 | ".SH DESCRIPTION\r\n"
|
|---|
| 67 | " \r\n"
|
|---|
| 68 | "NOTES:\r\n"
|
|---|
| 69 | " 1. The TFTP command allows to get the file specified by its 'remotefilepath'\r\n"
|
|---|
| 70 | " path from the TFTP server specified by its 'host' IPv4 address. If the\r\n"
|
|---|
| 71 | " optional 'localfilepath' parameter is provided, the downloaded file is\r\n"
|
|---|
| 72 | " stored locally using the provided file path. If the local file path is\r\n"
|
|---|
| 73 | " not specified, the file is stored in the current directory using the file\r\n"
|
|---|
| 74 | " server's name.\r\n"
|
|---|
| 75 | " 2. Before using the TFTP command, the network interface intended to be\r\n"
|
|---|
| 76 | " used to retrieve the file must be configured. This configuration may be\r\n"
|
|---|
| 77 | " done by means of the 'ifconfig' command.\r\n"
|
|---|
| 78 | " 3. If a network interface is defined with the '-i' option then only this\r\n"
|
|---|
| 79 | " interface will be used to retrieve the remote file. Otherwise, all network\r\n"
|
|---|
| 80 | " interfaces are tried in the order they have been discovered during the\r\n"
|
|---|
| 81 | " DXE phase.\r\n"
|
|---|
| 82 | ".SH EXAMPLES\r\n"
|
|---|
| 83 | " \r\n"
|
|---|
| 84 | "EXAMPLES:\r\n"
|
|---|
| 85 | " * To get the file "dir1/file1.dat" from the TFTP server 192.168.1.1 and\r\n"
|
|---|
| 86 | " store it as file2.dat in the current directory :\r\n"
|
|---|
| 87 | " fs0:\> tftp 192.168.1.1 dir1/file1.dat file2.dat\r\n"
|
|---|
| 88 | ".SH RETURNVALUES\r\n"
|
|---|
| 89 | " \r\n"
|
|---|
| 90 | "RETURN VALUES:\r\n"
|
|---|
| 91 | " SHELL_SUCCESS The action was completed as requested.\r\n"
|
|---|
| 92 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"
|
|---|
| 93 | " formatted or its value was out of bounds.\r\n"
|
|---|
| 94 |
|
|---|
