1// /**
2//
3// (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
4// Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved. <BR>
5// (C) Copyright 2017 Hewlett Packard Enterprise Development LP<BR>
6// SPDX-License-Identifier: BSD-2-Clause-Patent
7//
8// Module Name:
9//
10// UefiShellNetwork1CommandsLib.uni
11//
12// Abstract:
13//
14// String definitions for UEFI Shell 2.0 network 1 commands
15//
16//
17// **/
18
19/=#
20
21#langdef   en-US "english"
22
23#string STR_GEN_TOO_MANY          #language en-US "%H%s%N: Too many arguments.\r\n"
24#string STR_GEN_TOO_FEW           #language en-US "%H%s%N: Too few arguments.\r\n"
25#string STR_GEN_PARAM_INV         #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"
26#string STR_GEN_PROBLEM           #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
27#string STR_GEN_PROBLEM_OP2       #language en-US "%H%s%N: Invalid argument - '%H%s%N'. Expected '%B%s%N' or '%B%s%N'.\r\n"
28#string STR_GEN_PROBLEM_VAL       #language en-US "%H%s%N: Bad value - '%H%s%N' for flag - '%H%s%N'\r\n"
29#string STR_GEN_NO_VALUE          #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"
30#string STR_GEN_ERR_AD            #language en-US "%H%s%N: Access denied.\r\n"
31#string STR_GEN_ERR_UK            #language en-US "%H%s%N: Status: %r\r\n"
32#string STR_GEN_PARAM_CON         #language en-US "%H%s%N: Parameters conflict.\r\n"
33#string STR_GEN_FILE_OPEN_FAIL    #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"
34#string STR_GEN_FILE_AD           #language en-US "%H%s%N: Access file error - '%H%s%N'\r\n"
35#string STR_GEN_CRLF              #language en-US "\r\n"
36#string STR_GEN_NO_FILES          #language en-US "%H%s%N: No matching files were found.\r\n"
37#string STR_GEN_DIR_NF            #language en-US "%H%s%N: Directory not found - '%H%s%N'\r\n"
38#string STR_GEN_FILE_NF           #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"
39#string STR_GEN_IS_DIR            #language en-US "%H%s%N: '%H%s%N' is a directory\r\n"
40#string STR_GEN_PROTOCOL_NF       #language en-US "%H%s%N: The protocol '%H%s%N' is required and not found (%g).\r\n"
41#string STR_GEN_OUT_MEM           #language en-US "%H%s%N: Memory allocation was not successful.\r\n"
42
43#string STR_PING_INVALID_SOURCE      #language en-US "%Ping: Require source interface option\r\n"
44#string STR_PING_CONFIG              #language en-US "Config %r\r\n"
45#string STR_PING_GETMODE             #language en-US "GetModeData %r\r\n"
46#string STR_PING_GETDATA             #language en-US "GetData %r\r\n"
47#string STR_PING_RECEIVE             #language en-US "Receive %r\r\n"
48#string STR_PING_SEND_REQUEST        #language en-US "Echo request sequence %d did not complete successfully.\r\n"
49#string STR_PING_NOSOURCE_INDO       #language en-US "There are no sources in %s's multicast domain.\r\n"
50#string STR_PING_NETWORK_ERROR       #language en-US "%H%s%N: Network function failed with %r\r\n"
51#string STR_PING_CONFIGD_NIC_NF      #language en-US "%H%s%N: No configured interfaces were found.\r\n"
52#string STR_PING_NOROUTE_FOUND       #language en-US "There is no route to the destination '%B%s%N' from the source '%B%s%N' was found.\r\n"
53#string STR_PING_START               #language en-US "Ping %s %d data bytes.\r\n"
54#string STR_PING_TIMEOUT             #language en-US "Echo request sequence %d timeout.\r\n"
55#string STR_PING_REPLY_INFO          #language en-US "%d bytes from %s : icmp_seq=%d ttl=%d time%d~%dms\r\n"
56#string STR_PING_STAT                #language en-US "\n%d packets transmitted, %d received, %d%% packet loss, time %dms\r\n"
57#string STR_PING_RTT                 #language en-US "\nRtt(round trip time) min=%d~%dms max=%d~%dms avg=%d~%dms\r\n"
58
59#string STR_IFCONFIG_UNSUPPORTED_OPTION       #language en-US    "The option '%H%s%N' is unsupported now.\n"
60#string STR_IFCONFIG_LACK_OPTION              #language en-US    "Flags lack. Please type 'ifConfig -?' for help info.\n"
61#string STR_IFCONFIG_LACK_INTERFACE           #language en-US    "Lack interface name.\n"
62#string STR_IFCONFIG_LACK_COMMAND             #language en-US    "Lack interface config option.\n"
63#string STR_IFCONFIG_INVALID_INTERFACE        #language en-US    "Invalid interface name.\n"
64#string STR_IFCONFIG_INVALID_IPADDRESS        #language en-US    "Invalid ipv4 address: '%H%s%N'\n"
65#string STR_IFCONFIG_INVALID_GATEWAY          #language en-US    "Invalid gateway address: '%H%s%N'\n"
66#string STR_IFCONFIG_DUPLICATE_COMMAND        #language en-US    "Duplicate commands. Bad command %H%s%N is skipped.\n"
67#string STR_IFCONFIG_CONFLICT_COMMAND         #language en-US    "Conflict commands. Bad command %H%s%N is skipped.\n"
68#string STR_IFCONFIG_UNKNOWN_COMMAND          #language en-US    "Unknown commands. Bad command %H%s%N is skipped.\n"
69#string STR_IFCONFIG_SET_ADDR_FAILED          #language en-US    "Failed to set address.\n"
70#string STR_IFCONFIG_ROUTES_SIZE              #language en-US     "\n%H  Routes (%d entries):\n"
71#string STR_IFCONFIG_ROUTES_ENTRY_INDEX       #language en-US    "%H    Entry[%d]\n"
72#string STR_IFCONFIG_SHOW_IP_ADDR             #language en-US    "%12s: %N%d.%d.%d.%d\n"
73#string STR_IFCONFIG_INFO_NEWLINE             #language en-US    "\n"
74#string STR_IFCONFIG_INFO_DNS_ADDR_BODY       #language en-US    "%8d.%d.%d.%d\n"
75#string STR_IFCONFIG_INFO_BREAK               #language en-US    "\n-----------------------------------------------------------------\n"
76#string STR_IFCONFIG_INFO_COLON               #language en-US    ":"
77#string STR_IFCONFIG_INFO_IF_NAME             #language en-US    "\n%Hname         : %s%N\n"
78#string STR_IFCONFIG_INFO_MEDIA_STATE         #language en-US    "%HMedia State  : %s%N\n"
79#string STR_IFCONFIG_INFO_POLICY_DHCP         #language en-US    "%Hpolicy       : dhcp%N\n"
80#string STR_IFCONFIG_INFO_POLICY_MAN          #language en-US    "%Hpolicy       : static%N\n"
81#string STR_IFCONFIG_INFO_MAC_ADDR_HEAD       #language en-US    "%Hmac addr     : %N"
82#string STR_IFCONFIG_INFO_MAC_ADDR_BODY       #language en-US    "%02x"
83#string STR_IFCONFIG_INFO_IP_ADDR_HEAD        #language en-US    "\n%Hipv4 address : %N"
84#string STR_IFCONFIG_INFO_SUBNET_MASK_HEAD    #language en-US    "\n%Hsubnet mask  : %N"
85#string STR_IFCONFIG_INFO_GATEWAY_HEAD        #language en-US    "\n%Hdefault gateway: %N"
86#string STR_IFCONFIG_INFO_DNS_ADDR_HEAD       #language en-US    "\n%HDNS server   : %N\n"
87#string STR_IFCONFIG_INFO_IP_ADDR_BODY        #language en-US    "%d.%d.%d.%d\n"
88
89#string STR_GET_HELP_PING         #language en-US ""
90".TH ping 0 "Ping the target host with an IPv4 stack."\r\n"
91".SH NAME\r\n"
92"Ping the target host with an IPv4 stack.\r\n"
93".SH SYNOPSIS\r\n"
94" \r\n"
95"PING [-n count] [-l size] [-s SourceIp] TargetIp\r\n"
96".SH OPTIONS\r\n"
97" \r\n"
98"  -n       - Specifies the number of echo request datagrams to be sent.\r\n"
99"  -l       - Specifies the size of the data buffer in the echo request datagram.\r\n"
100"  -s       - Specifies the source adapter as IPv4 address.\r\n"
101"  SourceIp - Specifies the IPv4 address of the source machine.\r\n"
102"  TargetIp - Specifies the IPv4 address of the target machine.\r\n"
103".SH DESCRIPTION\r\n"
104" \r\n"
105"NOTES:\r\n"
106"  1. This command uses the ICMPv4 ECHO_REQUEST datagram to elicit an\r\n"
107"     ECHO_REPLY from a host.\r\n"
108".SH EXAMPLES\r\n"
109" \r\n"
110"EXAMPLES:\r\n"
111"  * To ping the target host with 64 bytes data:\r\n"
112"    fs0:\> ping -l 64 192.168.0.1\r\n"
113" \r\n"
114"  * To ping the target host by sending 20 echo request datagrams:\r\n"
115"    fs0:\> ping -n 20 202.120.100.1\r\n"
116" \r\n"
117"  * To ping the target host by specifying the source adapter as IPv4 address:\r\n"
118"    fs0:\> ping -s 202.120.100.12 202.120.100.1\r\n"
119".SH RETURNVALUES\r\n"
120" \r\n"
121"RETURN VALUES:\r\n"
122"  SHELL_SUCCESS             The action was completed as requested.\r\n"
123"  SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly\r\n"
124"                            formatted or its value was out of bounds.\r\n"
125
126#string STR_GET_HELP_IFCONFIG                 #language en-US    ""
127".TH ifconfig 0 "Modifies the default IP address of the UEFI IPv4 Network Stack."\r\n"
128".SH NAME\r\n"
129"Modifies the default IP address of the UEFI IPv4 Network Stack.\r\n"
130".SH SYNOPSIS\r\n"
131" \r\n"
132"IFCONFIG [-r [Name]] [-l [Name]]\r\n"
133"IFCONFIG [-s <Name> dhcp | <static <IP> <Mask>  <Gateway>> | <dns <IP>>]\r\n"
134".SH OPTIONS\r\n"
135" \r\n"
136"  -r          - Renew configuration of interface and set dhcp policy.\r\n"
137"  -l          - Lists the configuration.\r\n"
138"  -s          - Sets the configuration.\r\n"
139"  Name        - Specifies an adapter name (for example, eth0).\r\n"
140"  IP          - Specifies the IPv4 address in four integer values:\r\n"
141"                  - Example: 192.168.0.10\r\n"
142"  SubnetMask  - Specifies a subnet mask in four integer values:\r\n"
143"                  - Example: 255.255.255.0\r\n"
144"  GatewayMask - Specifies a default gateway in four integer values:\r\n"
145"                  - Example: 192.168.0.1\r\n"
146".SH DESCRIPTION\r\n"
147" \r\n"
148"NOTES:\r\n"
149"  1. This command modifies the default IP address for the UEFI IPv4\r\n"
150"     network stack.\r\n"
151"  2. Use '-r' to renew configuration of interface and set dhcp policy.\r\n"
152"  3. Use '-l' to list the DNS and other address related settings for all\r\n"
153"     interfaces or the specified interface.\r\n"
154"  4. Use '-s <Name> static <IP> <SubnetMask> <GatewayMask>' with \r\n"
155"     static IPv4 address configuration for specified interface.\r\n"
156"  5. Use '-s <Name> dhcp' for DHCPv4 to request the IPv4 address\r\n"
157"     configuration dynamically for specified interface.\r\n"
158"  6. Use '-s <Name> dns <IP>' must under manual policy.\r\n"
159".SH EXAMPLES\r\n"
160" \r\n"
161"EXAMPLES:\r\n"
162"  * To list the configuration for the eth0 interface:\r\n"
163"    fs0:\> ifconfig -l eth0\r\n"
164" \r\n"
165"  * To use DHCPv4 to request the IPv4 address configuration dynamically for the\r\n"
166"    eth0 interface:\r\n"
167"    fs0:\> ifconfig -s eth0 dhcp\r\n"
168" \r\n"
169"  * To use the static IPv4 address configuration for the eth0 interface:\r\n"
170"    fs0:\> ifconfig -s eth0 static 192.168.0.5 255.255.255.0 192.168.0.1\r\n"
171" \r\n"
172"  * To configure DNS server address for the eth0 interface:\r\n"
173"    fs0:\> ifconfig -s eth0 dns 192.168.0.8 192.168.0.9\r\n"
174
175
176
177