authenticate/vauthenticate.1
changeset 0 6f7a81934006
child 2 b3afb9f1e801
equal deleted inserted replaced
-1:000000000000 0:6f7a81934006
       
     1 .rn '' }`
       
     2 ''' $RCSfile$$Revision$$Date$
       
     3 '''
       
     4 ''' $Log$
       
     5 '''
       
     6 .de Sh
       
     7 .br
       
     8 .if t .Sp
       
     9 .ne 5
       
    10 .PP
       
    11 \fB\\$1\fR
       
    12 .PP
       
    13 ..
       
    14 .de Sp
       
    15 .if t .sp .5v
       
    16 .if n .sp
       
    17 ..
       
    18 .de Ip
       
    19 .br
       
    20 .ie \\n(.$>=3 .ne \\$3
       
    21 .el .ne 3
       
    22 .IP "\\$1" \\$2
       
    23 ..
       
    24 .de Vb
       
    25 .ft CW
       
    26 .nf
       
    27 .ne \\$1
       
    28 ..
       
    29 .de Ve
       
    30 .ft R
       
    31 
       
    32 .fi
       
    33 ..
       
    34 '''
       
    35 '''
       
    36 '''     Set up \*(-- to give an unbreakable dash;
       
    37 '''     string Tr holds user defined translation string.
       
    38 '''     Bell System Logo is used as a dummy character.
       
    39 '''
       
    40 .tr \(*W-|\(bv\*(Tr
       
    41 .ie n \{\
       
    42 .ds -- \(*W-
       
    43 .ds PI pi
       
    44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
       
    45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
       
    46 .ds L" ""
       
    47 .ds R" ""
       
    48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
       
    49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
       
    50 '''   such as .IP and .SH, which do another additional levels of
       
    51 '''   double-quote interpretation
       
    52 .ds M" """
       
    53 .ds S" """
       
    54 .ds N" """""
       
    55 .ds T" """""
       
    56 .ds L' '
       
    57 .ds R' '
       
    58 .ds M' '
       
    59 .ds S' '
       
    60 .ds N' '
       
    61 .ds T' '
       
    62 'br\}
       
    63 .el\{\
       
    64 .ds -- \(em\|
       
    65 .tr \*(Tr
       
    66 .ds L" ``
       
    67 .ds R" ''
       
    68 .ds M" ``
       
    69 .ds S" ''
       
    70 .ds N" ``
       
    71 .ds T" ''
       
    72 .ds L' `
       
    73 .ds R' '
       
    74 .ds M' `
       
    75 .ds S' '
       
    76 .ds N' `
       
    77 .ds T' '
       
    78 .ds PI \(*p
       
    79 'br\}
       
    80 .\"	If the F register is turned on, we'll generate
       
    81 .\"	index entries out stderr for the following things:
       
    82 .\"		TH	Title 
       
    83 .\"		SH	Header
       
    84 .\"		Sh	Subsection 
       
    85 .\"		Ip	Item
       
    86 .\"		X<>	Xref  (embedded
       
    87 .\"	Of course, you have to process the output yourself
       
    88 .\"	in some meaninful fashion.
       
    89 .if \nF \{
       
    90 .de IX
       
    91 .tm Index:\\$1\t\\n%\t"\\$2"
       
    92 ..
       
    93 .nr % 0
       
    94 .rr F
       
    95 .\}
       
    96 .TH VAUTHENTICATE 1 "vmailmgr 0.96.9" "2000-09-30" "VMailMgr Tools Documentation"
       
    97 .UC
       
    98 .if n .hy 0
       
    99 .if n .na
       
   100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
       
   101 .de CQ          \" put $1 in typewriter font
       
   102 .ft CW
       
   103 'if n "\c
       
   104 'if t \\&\\$1\c
       
   105 'if n \\&\\$1\c
       
   106 'if n \&"
       
   107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
       
   108 '.ft R
       
   109 ..
       
   110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
       
   111 .	\" AM - accent mark definitions
       
   112 .bd B 3
       
   113 .	\" fudge factors for nroff and troff
       
   114 .if n \{\
       
   115 .	ds #H 0
       
   116 .	ds #V .8m
       
   117 .	ds #F .3m
       
   118 .	ds #[ \f1
       
   119 .	ds #] \fP
       
   120 .\}
       
   121 .if t \{\
       
   122 .	ds #H ((1u-(\\\\n(.fu%2u))*.13m)
       
   123 .	ds #V .6m
       
   124 .	ds #F 0
       
   125 .	ds #[ \&
       
   126 .	ds #] \&
       
   127 .\}
       
   128 .	\" simple accents for nroff and troff
       
   129 .if n \{\
       
   130 .	ds ' \&
       
   131 .	ds ` \&
       
   132 .	ds ^ \&
       
   133 .	ds , \&
       
   134 .	ds ~ ~
       
   135 .	ds ? ?
       
   136 .	ds ! !
       
   137 .	ds /
       
   138 .	ds q
       
   139 .\}
       
   140 .if t \{\
       
   141 .	ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
       
   142 .	ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
       
   143 .	ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
       
   144 .	ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
       
   145 .	ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
       
   146 .	ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
       
   147 .	ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
       
   148 .	ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
       
   149 .	ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
       
   150 .\}
       
   151 .	\" troff and (daisy-wheel) nroff accents
       
   152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
       
   153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
       
   154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
       
   155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
       
   156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
       
   157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
       
   158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
       
   159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
       
   160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
       
   161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
       
   162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
       
   163 .ds ae a\h'-(\w'a'u*4/10)'e
       
   164 .ds Ae A\h'-(\w'A'u*4/10)'E
       
   165 .ds oe o\h'-(\w'o'u*4/10)'e
       
   166 .ds Oe O\h'-(\w'O'u*4/10)'E
       
   167 .	\" corrections for vroff
       
   168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
       
   169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
       
   170 .	\" for low resolution devices (crt and lpr)
       
   171 .if \n(.H>23 .if \n(.V>19 \
       
   172 \{\
       
   173 .	ds : e
       
   174 .	ds 8 ss
       
   175 .	ds v \h'-1'\o'\(aa\(ga'
       
   176 .	ds _ \h'-1'^
       
   177 .	ds . \h'-1'.
       
   178 .	ds 3 3
       
   179 .	ds o a
       
   180 .	ds d- d\h'-1'\(ga
       
   181 .	ds D- D\h'-1'\(hy
       
   182 .	ds th \o'bp'
       
   183 .	ds Th \o'LP'
       
   184 .	ds ae ae
       
   185 .	ds Ae AE
       
   186 .	ds oe oe
       
   187 .	ds Oe OE
       
   188 .\}
       
   189 .rm #[ #] #H #V #F C
       
   190 .SH "NAME"
       
   191 vauthenticate \- Authenticate a virtual user
       
   192 .SH "SYNOPSIS"
       
   193 \fBvauthenticate\fR
       
   194 .SH "DESCRIPTION"
       
   195 \fIvauthenticate\fR reads a domain name, user name, and pass phrase from
       
   196 standard input, and authenticates the virtual user.  If authentication
       
   197 is successful, it prints out information about the virtual user on
       
   198 stdout
       
   199 .PP
       
   200 The domain name, user name, and pass phrase are passed to
       
   201 \fIvauthenticate\fR on standard input each seperated by a NUL byte.
       
   202 .PP
       
   203 The output consists of a series of lines containing an identifier, an
       
   204 equal sign, and the data for that identifier, terminated by a newline.
       
   205 The identifiers are:
       
   206 .Ip "\s-1UID\s0" 4
       
   207 The base user's numerical user \s-1ID\s0.
       
   208 .Ip "\s-1GID\s0" 4
       
   209 The base user's numerical group \s-1ID\s0.
       
   210 .Ip "\s-1USER\s0" 4
       
   211 The base user's name.
       
   212 .Ip "\s-1HOME\s0" 4
       
   213 The base user's home directory.
       
   214 .Ip "\s-1MAILDIR\s0" 4
       
   215 The virtual user's mailbox directory, relative to \f(CWHOME\fR.
       
   216 .Ip "\s-1VUSER\s0" 4
       
   217 The virtual user's name.
       
   218 .SH "OPTIONS"
       
   219 None
       
   220 .SH "RETURN VALUE"
       
   221 Returns 0 if authentication succeeds, and non-zero otherwise.
       
   222 .SH "SEE ALSO"
       
   223 \fIvmailmgr\fR\|(7)
       
   224 .SH "CAVEATS"
       
   225 Although the output from \fIvauthenticate\fR appears to be suitable for
       
   226 using as shell input, care must be taken to escape characters that
       
   227 would cause the shell to misbehave, such as semicolons.
       
   228 .SH "RESTRICTIONS"
       
   229 This program will not authenticate non-virtual users.
       
   230 .SH "AUTHOR"
       
   231 Bruce Guenter <bruceg@em.ca>
       
   232 
       
   233 .rn }` ''
       
   234 .IX Title "VAUTHENTICATE 1"
       
   235 .IX Name "vauthenticate - Authenticate a virtual user"
       
   236 
       
   237 .IX Header "NAME"
       
   238 
       
   239 .IX Header "SYNOPSIS"
       
   240 
       
   241 .IX Header "DESCRIPTION"
       
   242 
       
   243 .IX Item "\s-1UID\s0"
       
   244 
       
   245 .IX Item "\s-1GID\s0"
       
   246 
       
   247 .IX Item "\s-1USER\s0"
       
   248 
       
   249 .IX Item "\s-1HOME\s0"
       
   250 
       
   251 .IX Item "\s-1MAILDIR\s0"
       
   252 
       
   253 .IX Item "\s-1VUSER\s0"
       
   254 
       
   255 .IX Header "OPTIONS"
       
   256 
       
   257 .IX Header "RETURN VALUE"
       
   258 
       
   259 .IX Header "SEE ALSO"
       
   260 
       
   261 .IX Header "CAVEATS"
       
   262 
       
   263 .IX Header "RESTRICTIONS"
       
   264 
       
   265 .IX Header "AUTHOR"
       
   266