wireless_tools/iwgetid.8

   1 .\" Guus Sliepen - 2001
   2 .\" Completed and fixed up by Jean Tourrilhes - 2002-2003
   3 .\" iwgetid.8
   4 .\"
   5 .TH IWGETID 8 "02 December 2003" "wireless-tools" "Linux Programmer's Manual"
   6 .\"
   7 .\" NAME part
   8 .\"
   9 .SH NAME
  10 iwgetid \- Report ESSID, NWID or AP/Cell Address of wireless network
  11 .\"
  12 .\" SYNOPSIS part
  13 .\"
  14 .SH SYNOPSIS
  15 .BI "iwgetid " [interface] " [--raw] [--scheme] [--ap] [--freq]"
  16 .br
  17 .BI "                   [--mode] [--protocol] [--channel]
  18 .br
  19 .\"
  20 .\" DESCRIPTION part
  21 .\"
  22 .SH DESCRIPTION
  23 .B iwgetid
  24 is used to find out the NWID, ESSID or AP/Cell Address of the wireless
  25 network that is currently used. The information reported is the same
  26 as the one shown by
  27 .BR iwconfig ", but " iwgetid
  28 is easier to integrate in various scripts.
  29 .br
  30 By default,
  31 .B iwgetid
  32 will print the
  33 .I ESSID
  34 of the device, and if the device doesn't have any ESSID it will print
  35 its
  36 .IR NWID .
  37 .br
  38 The default formatting output is pretty-print.
  39 .\"
  40 .\" OPTIONS part
  41 .\"
  42 .SH OPTIONS
  43 .TP
  44 .B --raw
  45 This option disables pretty-printing of the information. This option
  46 is orthogonal to the other options (except
  47 .BR --scheme ),
  48 so with the appropriate combination of options you can print the raw
  49 ESSID, AP Address or Mode.
  50 .br
  51 This format is ideal when storing the result of iwgetid as a
  52 variable in
  53 .I Shell
  54 or
  55 .I Perl
  56 scripts or to pass the result as an argument on the command line of
  57 .BR iwconfig .
  58 .TP
  59 .B --scheme
  60 This option is similar to the previous one, it disables
  61 pretty-printing of the information and removes all characters that are
  62 not alphanumerics (like space, punctuation and control characters).
  63 .br
  64 The resulting output is a valid Pcmcia scheme identifier (that may be
  65 used as an argument of the command
  66 .BR "cardctl scheme" ).
  67 This format is also ideal when using the result of iwgetid as a
  68 selector in
  69 .I Shell
  70 or
  71 .I Perl
  72 scripts, or as a file name.
  73 .TP
  74 .B --ap
  75 Display the MAC address of the Wireless
  76 .I Access Point
  77 or the
  78 .IR Cell .
  79 .TP
  80 .B --freq
  81 Display the current
  82 .I frequency
  83 or
  84 .I channel
  85 used by the interface.
  86 .TP
  87 .B --channel
  88 Display the current
  89 .I channel
  90 used by the interface. The channel is determined using the current
  91 frequency and the frequency list provided by the interface.
  92 .TP
  93 .B --mode
  94 Display the current
  95 .I mode
  96 of the interface.
  97 .TP
  98 .B --protocol
  99 Display the
 100 .I protocol name
 101 of the interface. This allows to identify all the cards that are
 102 compatible with each other and accept the same type of configuration.
 103 .br
 104 This can also be used to
 105 .I check Wireless Extension support
 106 on the interface, as this is the only attribute that all drivers
 107 supporting Wireless Extension are mandated to support.
 108 .\"
 109 .\" SEE ALSO part
 110 .\"
 111 .SH SEE ALSO
 112 .BR iwconfig (8),
 113 .BR ifconfig (8),
 114 .BR iwspy (8),
 115 .BR iwpriv (8).