ShellPkg/tftp: Convert from NULL class library to Dynamic Command

[mirror_edk2.git] / ShellPkg / DynamicCommand / TftpDynamicCommand / Tftp.uni

// /**\r
//\r
// (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>\r
// Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved. <BR>\r
// This program and the accompanying materials\r
// are licensed and made available under the terms and conditions of the BSD License\r
// which accompanies this distribution. The full text of the license may be found at\r
// http://opensource.org/licenses/bsd-license.php\r
//\r
// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
//\r
// Module Name:\r
//\r
// UefiShellTftpCommandLib.uni\r
//\r
// Abstract:\r
//\r
// String definitions for UEFI Shell TFTP command\r
//\r
//\r
// **/\r
\r
/=#\r
\r
#langdef   en-US "english"\r
\r
#string STR_GEN_TOO_MANY           #language en-US "%H%s%N: Too many arguments\r\n"\r
#string STR_GEN_TOO_FEW            #language en-US "%H%s%N: Too few arguments\r\n"\r
#string STR_GEN_PARAM_INV          #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"\r
#string STR_GEN_PROBLEM            #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"\r
#string STR_GEN_FILE_OPEN_FAIL     #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"\r
#string STR_GEN_CRLF               #language en-US "\r\n"\r
\r
#string STR_TFTP_ERR_NO_NIC        #language en-US "No network interface card found.\r\n"\r
#string STR_TFTP_ERR_NIC_NAME      #language en-US "Failed to get the name of the network interface card number %d - %r\r\n"\r
#string STR_TFTP_ERR_OPEN_PROTOCOL #language en-US "Unable to open MTFTP4 protocol on '%H%s%N' - %r\r\n"\r
#string STR_TFTP_ERR_CONFIGURE     #language en-US "Unable to configure MTFTP4 protocol on '%H%s%N' - %r\r\n"\r
#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"\r
#string STR_TFTP_ERR_DOWNLOAD      #language en-US "Unable to download the file '%H%s%N' on '%H%s%N' - %r\r\n"\r
#string STR_TFTP_ERR_WRITE         #language en-US "Unable to write into file '%H%s%N' - %r\r\n"\r
#string STR_TFTP_ERR_NIC_NOT_FOUND #language en-US "Network Interface Card '%H%s%N' not found.\r\n"\r
#string STR_TFTP_DOWNLOADING       #language en-US "Downloading the file '%H%s%N'\r\n"\r
#string STR_TFTP_STRING            #language en-US "%s"\r
\r
#string STR_GET_HELP_TFTP          #language en-US ""\r
".TH tftp 0 "Download a file from TFTP server."\r\n"\r
".SH NAME\r\n"\r
"Download a file from TFTP server.\r\n"\r
".SH SYNOPSIS\r\n"\r
" \r\n"\r
"TFTP [-i interface] [-l <port>] [-r <port>] [-c <retry count>] [-t <timeout>]\r\n"\r
"     [-s <block size>] host remotefilepath [localfilepath]\r\n"\r
".SH OPTIONS\r\n"\r
" \r\n"\r
"  -i interface     - Specifies an adapter name, i.e., eth0.\r\n"\r
"  -l port          - Specifies the local port number. Default value is 0\r\n"\r
"                     and the port number is automatically assigned.\r\n"\r
"  -r port          - Specifies the remote port number. Default value is 69.\r\n"\r
"  -c <retry count> - The number of times to transmit request packets and\r\n"\r
"                     wait for a response. The default value is 6.\r\n"\r
"  -t <timeout>     - The number of seconds to wait for a response after\r\n"\r
"                     sending a request packet. Default value is 4s.\r\n"\r
"  -s <block size>  - Specifies the TFTP blksize option as defined in RFC 2348.\r\n"\r
"                     Valid range is between 8 and 65464, default value is 512.\r\n"\r
"  host             - Specify TFTP Server IPv4 address.\r\n"\r
"  remotefilepath   - TFTP server file path to download the file.\r\n"\r
"  localfilepath    - Local destination file path.\r\n"\r
".SH DESCRIPTION\r\n"\r
" \r\n"\r
"NOTES:\r\n"\r
"  1. The TFTP command allows to get the file specified by its 'remotefilepath'\r\n"\r
"     path from the TFTP server specified by its 'host' IPv4 address. If the\r\n"\r
"     optional 'localfilepath' parameter is provided, the downloaded file is\r\n"\r
"     stored locally using the provided file path. If the local file path is\r\n"\r
"     not specified, the file is stored in the current directory using the file\r\n"\r
"     server's name.\r\n"\r
"  2. Before using the TFTP command, the network interface intended to be\r\n"\r
"     used to retrieve the file must be configured. This configuration may be\r\n"\r
"     done by means of the 'ifconfig' command.\r\n"\r
"  3. If a network interface is defined with the '-i' option then only this\r\n"\r
"     interface will be used to retrieve the remote file. Otherwise, all network\r\n"\r
"     interfaces are tried in the order they have been discovered during the\r\n"\r
"     DXE phase.\r\n"\r
".SH EXAMPLES\r\n"\r
" \r\n"\r
"EXAMPLES:\r\n"\r
"  * To get the file "dir1/file1.dat" from the TFTP server 192.168.1.1 and\r\n"\r
"    store it as file2.dat in the current directory :\r\n"\r
"    fs0:\> tftp 192.168.1.1 dir1/file1.dat file2.dat\r\n"\r
".SH RETURNVALUES\r\n"\r
" \r\n"\r
"RETURN VALUES:\r\n"\r
"  SHELL_SUCCESS             The action was completed as requested.\r\n"\r
"  SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly\r\n"\r
"                            formatted or its value was out of bounds.\r\n"\r
\r