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