ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1CommandsLib.uni

   1 // /**
   2 //
   3 // (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
   4 // Copyright (c) 2010 - 2015, 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 // UefiShellNetwork1CommandsLib.uni
  16 //
  17 // Abstract:
  18 //
  19 // String definitions for UEFI Shell 2.0 network 1 commands
  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_PROBLEM_OP2       #language en-US "%H%s%N: Invalid argument - '%H%s%N'. Expected '%B%s%N' or '%B%s%N'.\r\n"
  33 #string STR_GEN_PROBLEM_VAL       #language en-US "%H%s%N: Bad value - '%H%s%N' for flag - '%H%s%N'\r\n"
  34 #string STR_GEN_NO_VALUE          #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"
  35 #string STR_GEN_ERR_AD            #language en-US "%H%s%N: Access denied.\r\n"
  36 #string STR_GEN_ERR_UK            #language en-US "%H%s%N: Status: %r\r\n"
  37 #string STR_GEN_PARAM_CON         #language en-US "%H%s%N: Parameters conflict.\r\n"
  38 #string STR_GEN_FILE_OPEN_FAIL    #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"
  39 #string STR_GEN_FILE_AD           #language en-US "%H%s%N: Access file error - '%H%s%N'\r\n"
  40 #string STR_GEN_CRLF              #language en-US "\r\n"
  41 #string STR_GEN_NO_FILES          #language en-US "%H%s%N: No matching files were found.\r\n"
  42 #string STR_GEN_DIR_NF            #language en-US "%H%s%N: Directory not found - '%H%s%N'\r\n"
  43 #string STR_GEN_FILE_NF           #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"
  44 #string STR_GEN_IS_DIR            #language en-US "%H%s%N: '%H%s%N' is a directory\r\n"
  45 #string STR_GEN_PROTOCOL_NF       #language en-US "%H%s%N: The protocol '%H%s%N' is required and not found (%g).\r\n"
  46
  47 #string STR_PING_CONFIG              #language en-US "Config %r\r\n"
  48 #string STR_PING_GETMODE             #language en-US "GetModeData %r\r\n"
  49 #string STR_PING_GETDATA             #language en-US "GetData %r\r\n"
  50 #string STR_PING_SEND_REQUEST        #language en-US "Echo request sequence %d did not complete successfully.\r\n"
  51 #string STR_PING_NOSOURCE_INDO       #language en-US "There are no sources in %s's multicast domain.\r\n"
  52 #string STR_PING_NETWORK_ERROR       #language en-US "%H%s%N: Network function failed with %r\r\n"
  53 #string STR_PING_CONFIGD_NIC_NF      #language en-US "%H%s%N: No configured interfaces were found.\r\n"
  54 #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"
  55 #string STR_PING_START               #language en-US "Ping %s %d data bytes.\r\n"
  56 #string STR_PING_TIMEOUT             #language en-US "Echo request sequence %d timeout.\r\n"
  57 #string STR_PING_REPLY_INFO          #language en-US "%d bytes from %s : icmp_seq=%d ttl=%d time%c%dms\r\n"
  58 #string STR_PING_STAT                #language en-US "\n%d packets transmitted, %d received, %d%% packet loss, time %dms\r\n"
  59 #string STR_PING_RTT                 #language en-US "\nRtt(round trip time) min=%dms max=%dms avg=%dms\r\n"
  60
  61 #string STR_IFCONFIG_UNSUPPORTED_OPTION       #language en-US    "The option '%H%s%N' is unsupported now.\n"
  62 #string STR_IFCONFIG_LACK_OPTION              #language en-US    "Flags lack.\n"
  63 #string STR_IFCONFIG_LACK_INTERFACE           #language en-US    "Lack interface name.\n"
  64 #string STR_IFCONFIG_LACK_COMMAND             #language en-US    "Lack interface config option.\n"
  65 #string STR_IFCONFIG_INVALID_INTERFACE        #language en-US    "Invalid interface name.\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    "It failed to set .\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 "Pings the target host with an IPv4 or IPv6 stack."\r\n"
  91 ".SH NAME\r\n"
  92 "Pings the target host with an IPv4 or IPv6 stack.\r\n"
  93 ".SH SYNOPSIS\r\n"
  94 " \r\n"
  95 "PING [-_ip6] [-_s SourceIp] [-n count] [-l size] 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 "  -_ip6    - Specifies the IPv6 stack usage mode (Default is IPv4 stack).\r\n"
 101 "  -_s      - Specifies the source adapter as IPv4 or IPv6 address.\r\n"
 102 "  SourceIp - Specifies the IPv4 or IPv6 address of the source machine.\r\n"
 103 "  TargetIp - Specifies the IPv4 or IPv6 address of the target machine.\r\n"
 104 ".SH DESCRIPTION\r\n"
 105 " \r\n"
 106 "NOTES:\r\n"
 107 "  1. This command uses the ICMPv4 or ICMPv6 ECHO_REQUEST datagram to elicit an\r\n"
 108 "     ECHO_REPLY from a host.\r\n"
 109 ".SH EXAMPLES\r\n"
 110 " \r\n"
 111 "EXAMPLES:\r\n"
 112 "  * To ping the target host with 64 bytes data:\r\n"
 113 "    fs0:\> ping -l 64 192.168.0.1\r\n"
 114 " \r\n"
 115 "  * To ping the target host by sending 20 echo request datagrams:\r\n"
 116 "    fs0:\> ping -n 20 202.120.100.1\r\n"
 117 " \r\n"
 118 "  * To ping the target host by specifying the source adapter as IPv4 address:\r\n"
 119 "    fs0:\> ping -_s 202.120.100.12 202.120.100.1\r\n"
 120 " \r\n"
 121 "  * To ping the target host by specifying the IPv6 stack usage mode:\r\n"
 122 "    fs0:\> ping -_ip6 2000:bbbb::8\r\n"
 123 ".SH RETURNVALUES\r\n"
 124 " \r\n"
 125 "RETURN VALUES:\r\n"
 126 "  SHELL_SUCCESS             The action was completed as requested.\r\n"
 127 "  SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly\r\n"
 128 "                            formatted or its value was out of bounds.\r\n"
 129
 130 #string STR_GET_HELP_IFCONFIG                 #language en-US    ""
 131 ".TH ifconfig 0 "Modifies the default IP address of the UEFI IPv4 Network Stack."\r\n"
 132 ".SH NAME\r\n"
 133 "Modifies the default IP address of the UEFI IPv4 Network Stack.\r\n"
 134 ".SH SYNOPSIS\r\n"
 135 " \r\n"
 136 "IFCONFIG [-r [Name]] [-l [Name]]\r\n"
 137 "IFCONFIG [-s <Name> dhcp | <static <IP> <Mask>  <Gateway>> | <dns <IP>>]\r\n"
 138 ".SH OPTIONS\r\n"
 139 " \r\n"
 140 "  -r          - Renew configuration of interface and set dhcp policy.\r\n"
 141 "  -l          - Lists the configuration.\r\n"
 142 "  -s          - Sets the configuration.\r\n"
 143 "  Name        - Specifies an adapter name (for example, eth0).\r\n"
 144 "  IP          - Specifies the IPv4 address in four integer values:\r\n"
 145 "                  - Example: 192.168.0.10\r\n"
 146 "  SubnetMask  - Specifies a subnet mask in four integer values:\r\n"
 147 "                  - Example: 255.255.255.0\r\n"
 148 "  GatewayMask - Specifies a default gateway in four integer values:\r\n"
 149 "                  - Example: 192.168.0.1\r\n"
 150 ".SH DESCRIPTION\r\n"
 151 " \r\n"
 152 "NOTES:\r\n"
 153 "  1. This command modifies the default IP address for the UEFI IP4\r\n"
 154 "     network stack.\r\n"
 155 "  2. Use '-r' to renew configuration of interface and set dhcp policy.\r\n"
 156 "  3. Use '-l' to list the DNS and other address related settings for all\r\n"
 157 "     interfaces or the specified interface.\r\n"
 158 "  4. Use '-s <Name> static <IP> <SubnetMask> <GatewayMask>' with \r\n"
 159 "     static IP4 address configuration for all or specified interface.\r\n"
 160 "  5. Use '-s <Name> dhcp' for DHCP4 to request the IP4 address\r\n"
 161 "     configuration dynamically for all interface or specified interface.\r\n"
 162 "  6. Use '-s <Name> dns <IP>' must under manual policy.\r\n"
 163 ".SH EXAMPLES\r\n"
 164 " \r\n"
 165 "EXAMPLES:\r\n"
 166 "  * To list the configuration for the eth0 interface:\r\n"
 167 "    fs0:\> ifconfig -l eth0\r\n"
 168 " \r\n"
 169 "  * To use DHCP4 to request the IPv4 address configuration dynamically for the\r\n"
 170 "    eth0 interface:\r\n"
 171 "    fs0:\> ifconfig -s eth0 dhcp\r\n"
 172 " \r\n"
 173 "  * To use the static IPv4 address configuration for the eth0 interface:\r\n"
 174 "    fs0:\> ifconfig -s eth0 static 192.168.0.5 255.255.255.0 192.168.0.1\r\n"
 175 " \r\n"
 176 "  * To configure DNS server address for the eth0 interface:\r\n"
 177 "    fs0:\> ifconfig -s eth0 dns 192.168.0.8 192.168.0.9\r\n"
 178
 179
 180