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