grub-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] add documentation for net commands


From: Andrey Borzenkov
Subject: [PATCH] add documentation for net commands
Date: Sun, 25 Aug 2013 17:05:59 +0400

texinfo provides command index by default, so there is no need to list them
all in single list, it is much easier found in index if needed. Introduce
new section Networking commands to make it easier to find related entries.

Signed-off-by: Andrey Borzenkov <address@hidden>

---
 docs/grub.texi | 175 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 175 insertions(+)

diff --git a/docs/grub.texi b/docs/grub.texi
index d5ed014..3cf924b 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -3231,6 +3231,7 @@ shell}.
 * Menu-specific commands::
 * General commands::
 * Command-line and menu entry commands::
+* Networking commands::
 @end menu
 
 
@@ -4631,6 +4632,180 @@ only on PC BIOS platforms.
 List available video modes. If resolution is given, show only matching modes.
 @end deffn
 
address@hidden Networking commands
address@hidden The list of networking commands
+
address@hidden
+* net_add_addr::                Add a network address
+* net_add_dns::                 Add a DNS server
+* net_add_route::               Add routing entry
+* net_bootp::                   Perform a bootp autoconfiguration
+* net_del_addr::                Remove IP address from interface
+* net_del_dns::                 Remove a DNS server
+* net_del_route::               Remove a route entry
+* net_get_dhcp_option::         Retrieve DHCP options
+* net_ipv6_autoconf::           Perform IPv6 autoconfiguration
+* net_ls_addr::                 List interfaces
+* net_ls_cards::                List network cards
+* net_ls_dns::                  List DNS servers
+* net_ls_routes::               List routing entries
+* net_nslookup::                Perform a DNS lookup
address@hidden menu
+
+
address@hidden net_add_addr
address@hidden net_add_addr
+
address@hidden Command net_add_addr @var{interface} @var{card} @var{address}
+Configure additional network @var{interface} with @var{address} on a
+network @var{card}. @var{address} can be either IP in dotted decimal notation,
+or symbolic name which is resolved using DNS lookup. If successful, this 
command
+also adds local link routing entry to the default subnet of @var{address}
+with name @address@hidden:local} via @var{interface}.
address@hidden deffn
+
+
address@hidden net_add_dns
address@hidden net_add_dns
+
address@hidden Command net_add_dns @var{server}
+Resolve @var{server} IP address and add to the list of DNS servers used during
+name lookup.
address@hidden deffn
+
+
address@hidden net_add_route
address@hidden net_add_route
+
address@hidden Command net_add_route @var{shortname} @var{ip}[/@var{prefix}] 
address@hidden | @samp{gw} @var{gateway}]
+Add route to network with address @var{ip} as modified by @var{prefix} via
+either local @var{interface} or @var{gateway}. @var{prefix} is optional and
+defaults to 32 for IPv4 address and 128 for IPv6 address. Router is identified
+by @var{shortname} which can be used to remove it (@pxref{net_del_route}).
address@hidden deffn
+
+
address@hidden net_bootp
address@hidden net_bootp
+
address@hidden Command net_bootp address@hidden
+Perform configuration of @var{card} using DHCP protocol. If no card name
+is specified, try to configure all existing cards. If configuration was
+successful, interface with name @address@hidden:dhcp} and configured
+address is added to @var{card}. If server provided gateway information in
+DHCP ACK packet, it is added as route entry with the name 
@address@hidden:dhcp:gw}. Additionally the following DHCP options are 
recognized and processed:
+
address@hidden @samp
address@hidden 1 (Subnet Mask)
+Used to calculate network local routing entry for interface 
@address@hidden:dhcp}.
address@hidden 3 (Router)
+Adds default route entry with the name @address@hidden:dhcp:default} via 
gateway
+from DHCP option. Note that only option with single route is accepted.
address@hidden 6 (Domain Name Server)
+Adds all servers from option value to the list of servers used during name 
resolution.
address@hidden 12 (Host Name)
+Sets environment variable @address@hidden<card>address@hidden
+(@address@hidden<interface>}_hostname}) to the value of option.
address@hidden 15 (Domain Name)
+Sets environment variable @address@hidden<card>address@hidden
+(@address@hidden<interface>}_domain}) to the value of option.
address@hidden 17 (Root Path)
+Sets environment variable @address@hidden<card>address@hidden
+(@address@hidden<interface>}_rootpath}) to the value of option.
address@hidden 18 (Extensions Path)
+Sets environment variable @address@hidden<card>address@hidden
+(@address@hidden<interface>}_extensionspath}) to the value of option.
address@hidden table
+
address@hidden deffn
+
+
address@hidden net_del_addr
address@hidden net_del_addr
+
address@hidden Command net_del_addr @var{interface}
+Remove configured @var{interface} with associated address.
address@hidden deffn
+
+
address@hidden net_del_dns
address@hidden net_del_dns
+
address@hidden Command net_del_dns @var{address}
+Remove @var{address} from list of servers used during name lookup.
address@hidden deffn
+
+
address@hidden net_del_route
address@hidden net_del_route
+
address@hidden Command net_del_route @var{shortname}
+Remove route entry identified by @var{shortname}.
address@hidden deffn
+
+
address@hidden net_get_dhcp_option
address@hidden net_get_dhcp_option
+
address@hidden Command net_get_dhcp_option @var{var} @var{interface} 
@var{number} @var{type}
+Request DHCP option @var{number} of @var{type} via @var{interface}. @var{type}
+can be one of @samp{string}, @samp{number} or @samp{hex}. If option is found,
+assign its value to variable @var{var}. Values of types @samp{number} and 
@samp{hex}
+are converted to string representation.
address@hidden deffn
+
+
address@hidden net_ipv6_autoconf
address@hidden net_ipv6_autoconf
+
address@hidden Command net_ipv6_autoconf address@hidden
+Perform IPv6 autoconfiguration by adding to the @var{card} interface with name
address@hidden@samp{:link} and link local MAC-based address. If no card is 
specified,
+perform autoconfiguration for all existing cards.
address@hidden deffn
+
+
address@hidden net_ls_addr
address@hidden net_ls_addr
+
address@hidden Command net_ls_addr
+List all configured interfaces with their MAC and IP addresses.
address@hidden deffn
+
+
address@hidden net_ls_cards
address@hidden net_ls_cards
+
address@hidden Command net_ls_cards
+List all detected network cards with their MAC address.
address@hidden deffn
+
+
address@hidden net_ls_dns
address@hidden net_ls_dns
+
address@hidden Command net_ls_dns
+List addresses of DNS servers used during name lookup.
address@hidden deffn
+
+
address@hidden net_ls_routes
address@hidden net_ls_routes
+
address@hidden Command net_ls_routes
+List routing entries.
address@hidden deffn
+
+
address@hidden net_nslookup
address@hidden net_nslookup
+
address@hidden Command net_nslookup @var{name} address@hidden
+Resolve address of @var{name} using DNS server @var{server}. If no server
+is given, use default list of servers.
address@hidden deffn
+
+
 @node Internationalisation
 @chapter Charset
 GRUB uses UTF-8 internally other than in rendering where some GRUB-specific
-- 
tg: (65777ed..) u/doc/net_cmd (depends on: master)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]