Home | History | Annotate | Download | only in UefiShellNetwork1CommandsLib
      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_INVALID_IPADDRESS        #language en-US    "Invalid ipv4 address: '%H%s%N'\n"
     67 #string STR_IFCONFIG_DUPLICATE_COMMAND        #language en-US    "Duplicate commands. Bad command %H%s%N is skipped.\n"
     68 #string STR_IFCONFIG_CONFLICT_COMMAND         #language en-US    "Conflict commands. Bad command %H%s%N is skipped.\n"
     69 #string STR_IFCONFIG_UNKNOWN_COMMAND          #language en-US    "Unknown commands. Bad command %H%s%N is skipped.\n"
     70 #string STR_IFCONFIG_SET_ADDR_FAILED          #language en-US    "Failed to set address.\n"
     71 #string STR_IFCONFIG_ROUTES_SIZE              #language en-US  	 "\n%H  Routes (%d entries):\n"
     72 #string STR_IFCONFIG_ROUTES_ENTRY_INDEX       #language en-US    "%H    Entry[%d]\n"
     73 #string STR_IFCONFIG_SHOW_IP_ADDR             #language en-US    "%12s: %N%d.%d.%d.%d\n"
     74 #string STR_IFCONFIG_INFO_NEWLINE             #language en-US    "\n"
     75 #string STR_IFCONFIG_INFO_DNS_ADDR_BODY       #language en-US    "%8d.%d.%d.%d\n"
     76 #string STR_IFCONFIG_INFO_BREAK               #language en-US    "\n-----------------------------------------------------------------\n"
     77 #string STR_IFCONFIG_INFO_COLON               #language en-US    ":"
     78 #string STR_IFCONFIG_INFO_IF_NAME             #language en-US    "\n%Hname         : %s%N\n"
     79 #string STR_IFCONFIG_INFO_MEDIA_STATE         #language en-US    "%HMedia State  : %s%N\n"
     80 #string STR_IFCONFIG_INFO_POLICY_DHCP         #language en-US    "%Hpolicy       : dhcp%N\n"
     81 #string STR_IFCONFIG_INFO_POLICY_MAN          #language en-US    "%Hpolicy       : static%N\n"
     82 #string STR_IFCONFIG_INFO_MAC_ADDR_HEAD       #language en-US    "%Hmac addr     : %N"
     83 #string STR_IFCONFIG_INFO_MAC_ADDR_BODY       #language en-US    "%02x"
     84 #string STR_IFCONFIG_INFO_IP_ADDR_HEAD        #language en-US    "\n%Hipv4 address : %N"
     85 #string STR_IFCONFIG_INFO_SUBNET_MASK_HEAD    #language en-US    "\n%Hsubnet mask  : %N"
     86 #string STR_IFCONFIG_INFO_GATEWAY_HEAD        #language en-US    "\n%Hdefault gateway: %N"
     87 #string STR_IFCONFIG_INFO_DNS_ADDR_HEAD       #language en-US    "\n%HDNS server   : %N\n"
     88 #string STR_IFCONFIG_INFO_IP_ADDR_BODY        #language en-US    "%d.%d.%d.%d\n"
     89 
     90 #string STR_GET_HELP_PING         #language en-US ""
     91 ".TH ping 0 "Pings the target host with an IPv4 or IPv6 stack."\r\n"
     92 ".SH NAME\r\n"
     93 "Pings the target host with an IPv4 or IPv6 stack.\r\n"
     94 ".SH SYNOPSIS\r\n"
     95 " \r\n"
     96 "PING [-_ip6] [-_s SourceIp] [-n count] [-l size] TargetIp\r\n"
     97 ".SH OPTIONS\r\n"
     98 " \r\n"
     99 "  -n       - Specifies the number of echo request datagrams to be sent.\r\n"
    100 "  -l       - Specifies the size of the data buffer in the echo request datagram.\r\n"
    101 "  -_ip6    - Specifies the IPv6 stack usage mode (Default is IPv4 stack).\r\n"
    102 "  -_s      - Specifies the source adapter as IPv4 or IPv6 address.\r\n"
    103 "  SourceIp - Specifies the IPv4 or IPv6 address of the source machine.\r\n"
    104 "  TargetIp - Specifies the IPv4 or IPv6 address of the target machine.\r\n"
    105 ".SH DESCRIPTION\r\n"
    106 " \r\n"
    107 "NOTES:\r\n"
    108 "  1. This command uses the ICMPv4 or ICMPv6 ECHO_REQUEST datagram to elicit an\r\n"
    109 "     ECHO_REPLY from a host.\r\n"
    110 ".SH EXAMPLES\r\n"
    111 " \r\n"
    112 "EXAMPLES:\r\n"
    113 "  * To ping the target host with 64 bytes data:\r\n"
    114 "    fs0:\> ping -l 64 192.168.0.1\r\n"
    115 " \r\n"
    116 "  * To ping the target host by sending 20 echo request datagrams:\r\n"
    117 "    fs0:\> ping -n 20 202.120.100.1\r\n"
    118 " \r\n"
    119 "  * To ping the target host by specifying the source adapter as IPv4 address:\r\n"
    120 "    fs0:\> ping -_s 202.120.100.12 202.120.100.1\r\n"
    121 " \r\n"
    122 "  * To ping the target host by specifying the IPv6 stack usage mode:\r\n"
    123 "    fs0:\> ping -_ip6 2000:bbbb::8\r\n"
    124 ".SH RETURNVALUES\r\n"
    125 " \r\n"
    126 "RETURN VALUES:\r\n"
    127 "  SHELL_SUCCESS             The action was completed as requested.\r\n"
    128 "  SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly\r\n"
    129 "                            formatted or its value was out of bounds.\r\n"
    130 
    131 #string STR_GET_HELP_IFCONFIG                 #language en-US    ""
    132 ".TH ifconfig 0 "Modifies the default IP address of the UEFI IPv4 Network Stack."\r\n"
    133 ".SH NAME\r\n"
    134 "Modifies the default IP address of the UEFI IPv4 Network Stack.\r\n"
    135 ".SH SYNOPSIS\r\n"
    136 " \r\n"
    137 "IFCONFIG [-r [Name]] [-l [Name]]\r\n"
    138 "IFCONFIG [-s <Name> dhcp | <static <IP> <Mask>  <Gateway>> | <dns <IP>>]\r\n"
    139 ".SH OPTIONS\r\n"
    140 " \r\n"
    141 "  -r          - Renew configuration of interface and set dhcp policy.\r\n"
    142 "  -l          - Lists the configuration.\r\n"
    143 "  -s          - Sets the configuration.\r\n"
    144 "  Name        - Specifies an adapter name (for example, eth0).\r\n"
    145 "  IP          - Specifies the IPv4 address in four integer values:\r\n"
    146 "                  - Example: 192.168.0.10\r\n"
    147 "  SubnetMask  - Specifies a subnet mask in four integer values:\r\n"
    148 "                  - Example: 255.255.255.0\r\n"
    149 "  GatewayMask - Specifies a default gateway in four integer values:\r\n"
    150 "                  - Example: 192.168.0.1\r\n"
    151 ".SH DESCRIPTION\r\n"
    152 " \r\n"
    153 "NOTES:\r\n"
    154 "  1. This command modifies the default IP address for the UEFI IP4\r\n"
    155 "     network stack.\r\n"
    156 "  2. Use '-r' to renew configuration of interface and set dhcp policy.\r\n"
    157 "  3. Use '-l' to list the DNS and other address related settings for all\r\n"
    158 "     interfaces or the specified interface.\r\n"
    159 "  4. Use '-s <Name> static <IP> <SubnetMask> <GatewayMask>' with \r\n"
    160 "     static IP4 address configuration for specified interface.\r\n"
    161 "  5. Use '-s <Name> dhcp' for DHCP4 to request the IP4 address\r\n"
    162 "     configuration dynamically for specified interface.\r\n"
    163 "  6. Use '-s <Name> dns <IP>' must under manual policy.\r\n"
    164 ".SH EXAMPLES\r\n"
    165 " \r\n"
    166 "EXAMPLES:\r\n"
    167 "  * To list the configuration for the eth0 interface:\r\n"
    168 "    fs0:\> ifconfig -l eth0\r\n"
    169 " \r\n"
    170 "  * To use DHCP4 to request the IPv4 address configuration dynamically for the\r\n"
    171 "    eth0 interface:\r\n"
    172 "    fs0:\> ifconfig -s eth0 dhcp\r\n"
    173 " \r\n"
    174 "  * To use the static IPv4 address configuration for the eth0 interface:\r\n"
    175 "    fs0:\> ifconfig -s eth0 static 192.168.0.5 255.255.255.0 192.168.0.1\r\n"
    176 " \r\n"
    177 "  * To configure DNS server address for the eth0 interface:\r\n"
    178 "    fs0:\> ifconfig -s eth0 dns 192.168.0.8 192.168.0.9\r\n"
    179                                                                   
    180 
    181 
    182