pretty-html-synopsis-20060228
[openafs.git] / doc / man-pages / pod1 / dpass.pod
1 =head1 NAME
2
3 dpass - Returns the DCE password for a new DCE account
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<dpass> S<<< [B<-cell> <I<original AFS cell name>>] >>> [B<-help>]
11
12 B<dpass> S<<< [B<-c> <I<original AFS cell name>>] >>> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<dpass> command returns the DCE password that an administrator
20 assigned to the issuer when using the B<dm pass> command to migrate AFS
21 user accounts into a DCE cell.
22
23 The B<dpass> command, issued on an AFS client, requests the issuer's new
24 DCE password from the AFS cell specified with the B<-cell> argument.
25
26 The issuer must be authenticated as the AFS user whose AFS account was
27 moved into DCE, and be able to provide the user's AFS password when
28 prompted by the B<dpass> command.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-cell> <I<cell name>>
35
36 Specifies the name of the AFS cell from which the AFS account was moved
37 into DCE and from which to fetch the new DCE password.
38
39 =item B<-help>
40
41 Prints the online help for this command. All other valid options are
42 ignored.
43
44 =back
45
46 =head1 OUTPUT
47
48 By default, the dpass command writes a message similar to the following to
49 the standard output stream.
50
51    Please read the following message before entering your password.
52
53    This program will display your new, temporary DCE password on your
54    terminal, and you should change the assigned password as soon as
55    possible (from a DCE client).  The program assumes that the AFS cell
56    uses the AFS Authentication Server and that an administrator used the
57    utilities in the AFS/DFS Migration Toolkit to migrate the account from
58    AFS to DCE. The password you enter should be the AFS password that was
59    in effect when your DCE account was created; this is not necessarily
60    the same password you have at the moment.  The cell name (which you may
61    override with a command line option), must be the name of the AFS cell
62    from which the authentication information was taken.
63
64 To suppress this message, set the DPASS_NO_MESSAGE environment
65 variable. It is then possible to substitute a customized message if
66 desired by using a script similar to the following example:
67
68    #! /bin/csh
69    echo "I<Start of customized message>"
70    echo "I<Continuation of customized message>"
71      .
72      .
73      .
74    echo "I<Conclusion of customized message>"
75    setenv DPASS_NO_MESSAGE
76    dpass $*
77
78 After the standard or customized message, if any, the dpass command
79 generates the following prompt for the original AFS password:
80
81    Original password for AFS cell <cell>:
82    Re-enter password to verify:
83
84 If the AFS passwords match and are correct, the command reports the
85 temporary DCE password in the following message.
86
87    The new DCE password is: <Issuer's_temporary_DCE_password
88
89 =head1 EXAMPLES
90
91 The following example returns the DCE password of the issuer, whose AFS
92 account is in the C<abc.com> cell. The DPASS_NO_MESSAGE variable has been
93 set to suppress the standard message.
94
95    % dpass
96    Original password for AFS cell abc.com: <Issuer's_AFS_password>
97    Re-enter password to verify: <Issuer's_AFS_password>
98    The new DCE password is: 8655--eg8e-dcdc-8157
99
100 =head1 PRIVILEGE REQUIRED
101
102 The issuer must be authenticated as the AFS user for whom to display the
103 corresponding DCE password.
104
105 =head1 SEE ALSO
106
107 L<dlog(1)>
108
109 B<dm pass> reference page in I<IBM AFS/DFS Migration Toolkit
110 Administration Guide and Reference>
111
112 =head1 COPYRIGHT
113
114 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
115
116 This documentation is covered by the IBM Public License Version 1.0.  It was
117 converted from HTML to POD by software written by Chas Williams and Russ
118 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.