automake build system
[mech_eap.orig] / wpa_supplicant / doc / docbook / wpa_passphrase.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2
3 <refentry>
4   <refmeta>
5     <refentrytitle>wpa_passphrase</refentrytitle>
6     <manvolnum>8</manvolnum>
7   </refmeta>
8   <refnamediv>
9     <refname>wpa_passphrase</refname>
10     <refpurpose>Generate a WPA PSK from an ASCII passphrase for a SSID</refpurpose>
11   </refnamediv>
12   <refsynopsisdiv>
13     <cmdsynopsis>
14       <command>wpa_passphrase</command>
15       <arg><replaceable>ssid</replaceable></arg>
16       <arg><replaceable>passphrase</replaceable></arg>
17     </cmdsynopsis>
18   </refsynopsisdiv>
19
20   <refsect1>
21     <title>Overview</title> 
22
23     <para><command>wpa_passphrase</command> pre-computes PSK entries for
24     network configuration blocks of a
25     <filename>wpa_supplicant.conf</filename> file. An ASCII passphrase
26     and SSID are used to generate a 256-bit PSK.</para>
27   </refsect1>
28
29   <refsect1>
30     <title>Options</title>
31     <variablelist>
32       <varlistentry>
33         <term>ssid</term>
34         <listitem>
35           <para>The SSID whose passphrase should be derived.</para>
36         </listitem>
37       </varlistentry>
38
39       <varlistentry>
40         <term>passphrase</term>
41         <listitem>
42           <para>The passphrase to use. If not included on the command line,
43           passphrase will be read from standard input.</para>
44         </listitem>
45       </varlistentry>
46     </variablelist>
47   </refsect1>
48
49   <refsect1>
50     <title>See Also</title>
51     <para>
52       <citerefentry>
53         <refentrytitle>wpa_supplicant.conf</refentrytitle>
54         <manvolnum>5</manvolnum>
55       </citerefentry>
56       <citerefentry>
57         <refentrytitle>wpa_supplicant</refentrytitle>
58         <manvolnum>8</manvolnum>
59       </citerefentry>
60     </para>
61
62   </refsect1>
63   <refsect1>
64     <title>Legal</title>
65     <para>wpa_supplicant is copyright (c) 2003-2007,
66     Jouni Malinen <email>j@w1.fi</email> and
67     contributors.
68     All Rights Reserved.</para>
69
70     <para>This program is dual-licensed under both the GPL version 2
71     and BSD license. Either license may be used at your option.</para>
72   </refsect1>
73 </refentry>