Ignore:
Timestamp:
May 27, 2009, 9:08:03 AM (16 years ago)
Author:
Herwig Bauernfeind
Message:

Update 3.2 branch to 3.2.8 docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/samba-3.2.x/docs/manpages/cifs.upcall.8

    r229 r231  
    11.\"     Title: cifs.upcall
    2 .\"    Author:
    3 .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
    4 .\"      Date: 12/19/2008
     2.\"    Author: [see the "AUTHOR" section]
     3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
     4.\"      Date: 02/03/2009
    55.\"    Manual: System Administration tools
    66.\"    Source: Samba 3.2
     7.\"  Language: English
    78.\"
    8 .TH "CIFS\.UPCALL" "8" "12/19/2008" "Samba 3\.2" "System Administration tools"
     9.TH "CIFS\&.UPCALL" "8" "02/03/2009" "Samba 3\&.2" "System Administration tools"
     10.\" -----------------------------------------------------------------
     11.\" * (re)Define some macros
     12.\" -----------------------------------------------------------------
     13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     14.\" toupper - uppercase a string (locale-aware)
     15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     16.de toupper
     17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
     18\\$*
     19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
     20..
     21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     22.\" SH-xref - format a cross-reference to an SH section
     23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     24.de SH-xref
     25.ie n \{\
     26.\}
     27.toupper \\$*
     28.el \{\
     29\\$*
     30.\}
     31..
     32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     33.\" SH - level-one heading that works better for non-TTY output
     34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     35.de1 SH
     36.\" put an extra blank line of space above the head in non-TTY output
     37.if t \{\
     38.sp 1
     39.\}
     40.sp \\n[PD]u
     41.nr an-level 1
     42.set-an-margin
     43.nr an-prevailing-indent \\n[IN]
     44.fi
     45.in \\n[an-margin]u
     46.ti 0
     47.HTML-TAG ".NH \\n[an-level]"
     48.it 1 an-trap
     49.nr an-no-space-flag 1
     50.nr an-break-flag 1
     51\." make the size of the head bigger
     52.ps +3
     53.ft B
     54.ne (2v + 1u)
     55.ie n \{\
     56.\" if n (TTY output), use uppercase
     57.toupper \\$*
     58.\}
     59.el \{\
     60.nr an-break-flag 0
     61.\" if not n (not TTY), use normal case (not uppercase)
     62\\$1
     63.in \\n[an-margin]u
     64.ti 0
     65.\" if not n (not TTY), put a border/line under subheading
     66.sp -.6
     67\l'\n(.lu'
     68.\}
     69..
     70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     71.\" SS - level-two heading that works better for non-TTY output
     72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     73.de1 SS
     74.sp \\n[PD]u
     75.nr an-level 1
     76.set-an-margin
     77.nr an-prevailing-indent \\n[IN]
     78.fi
     79.in \\n[IN]u
     80.ti \\n[SN]u
     81.it 1 an-trap
     82.nr an-no-space-flag 1
     83.nr an-break-flag 1
     84.ps \\n[PS-SS]u
     85\." make the size of the head bigger
     86.ps +2
     87.ft B
     88.ne (2v + 1u)
     89.if \\n[.$] \&\\$*
     90..
     91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     92.\" BB/BE - put background/screen (filled box) around block of text
     93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     94.de BB
     95.if t \{\
     96.sp -.5
     97.br
     98.in +2n
     99.ll -2n
     100.gcolor red
     101.di BX
     102.\}
     103..
     104.de EB
     105.if t \{\
     106.if "\\$2"adjust-for-leading-newline" \{\
     107.sp -1
     108.\}
     109.br
     110.di
     111.in
     112.ll
     113.gcolor
     114.nr BW \\n(.lu-\\n(.i
     115.nr BH \\n(dn+.5v
     116.ne \\n(BHu+.5v
     117.ie "\\$2"adjust-for-leading-newline" \{\
     118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
     119.\}
     120.el \{\
     121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
     122.\}
     123.in 0
     124.sp -.5v
     125.nf
     126.BX
     127.in
     128.sp .5v
     129.fi
     130.\}
     131..
     132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     133.\" BM/EM - put colored marker in margin next to block of text
     134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     135.de BM
     136.if t \{\
     137.br
     138.ll -2n
     139.gcolor red
     140.di BX
     141.\}
     142..
     143.de EM
     144.if t \{\
     145.br
     146.di
     147.ll
     148.gcolor
     149.nr BH \\n(dn
     150.ne \\n(BHu
     151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
     152.in 0
     153.nf
     154.BX
     155.in
     156.fi
     157.\}
     158..
     159.\" -----------------------------------------------------------------
     160.\" * set default formatting
     161.\" -----------------------------------------------------------------
    9162.\" disable hyphenation
    10163.nh
    11164.\" disable justification (adjust text to left margin only)
    12165.ad l
    13 .SH "NAME"
    14 cifs.upcall - Userspace upcall helper for Common Internet File System (CIFS)
    15 .SH "SYNOPSIS"
    16 .HP 1
    17 cifs\.upcall [\-c] [\-v] {keyid}
     166.\" -----------------------------------------------------------------
     167.\" * MAIN CONTENT STARTS HERE *
     168.\" -----------------------------------------------------------------
     169.SH "Name"
     170cifs.upcall \- Userspace upcall helper for Common Internet File System (CIFS)
     171.SH "Synopsis"
     172.fam C
     173.HP \w'\ 'u
     174\FCcifs\&.upcall\F[] [\-c] [\-v] {keyid}
     175.fam
    18176.SH "DESCRIPTION"
    19177.PP
    20178This tool is part of the
    21179\fBsamba\fR(7)
    22 suite\.
    23 .PP
    24 cifs\.upcall is a userspace helper program for the linux CIFS client filesystem\. There are a number of activities that the kernel cannot easily do itself\. This program is a callout program that does these things for the kernel and then returns the result\.
    25 .PP
    26 cifs\.upcall is generally intended to be run when the kernel calls request\-key(8)
    27 for a particular key type\. While it can be run directly from the command\-line, it\'s not generally intended to be run that way\.
     180suite\&.
     181.PP
     182cifs\&.upcall is a userspace helper program for the linux CIFS client filesystem\&. There are a number of activities that the kernel cannot easily do itself\&. This program is a callout program that does these things for the kernel and then returns the result\&.
     183.PP
     184cifs\&.upcall is generally intended to be run when the kernel calls request\-key(8)
     185for a particular key type\&. While it can be run directly from the command\-line, it\'s not generally intended to be run that way\&.
    28186.SH "OPTIONS"
    29187.PP
    30188\-c
    31189.RS 4
    32 When handling a kerberos upcall, use a service principal that starts with "cifs/"\. The default is to use the "host/" service principal\.
     190When handling a kerberos upcall, use a service principal that starts with "cifs/"\&. The default is to use the "host/" service principal\&.
    33191.RE
    34192.PP
    35193\-v
    36194.RS 4
    37 Print version number and exit\.
     195Print version number and exit\&.
    38196.RE
    39197.SH "CONFIGURATION FOR KEYCTL"
    40198.PP
    41 cifs\.upcall is designed to be called from the kernel via the request\-key callout program\. This requires that request\-key be told where and how to call this program\. The current cifs\.upcall program handles two different key types:
    42 .PP
    43 cifs\.spnego
     199cifs\&.upcall is designed to be called from the kernel via the request\-key callout program\&. This requires that request\-key be told where and how to call this program\&. The current cifs\&.upcall program handles two different key types:
     200.PP
     201cifs\&.spnego
    44202.RS 4
    45203This keytype is for retrieving kerberos session keys
     
    51209.RE
    52210.PP
    53 To make this program useful for CIFS, you\'ll need to set up entries for them in request\-key\.conf(5)\. Here\'s an example of an entry for each key type:
     211To make this program useful for CIFS, you\'ll need to set up entries for them in request\-key\&.conf(5)\&. Here\'s an example of an entry for each key type:
    54212.sp
    55 .RS 4
     213.if n \{\
     214.RS 4
     215.\}
     216.fam C
     217.ps -1
    56218.nf
    57 #OPERATION  TYPE           D C PROGRAM ARG1 ARG2\.\.\.
     219.if t \{\
     220.sp -1
     221.\}
     222.BB lightgray adjust-for-leading-newline
     223.sp -1
     224
     225#OPERATION  TYPE           D C PROGRAM ARG1 ARG2\&.\&.\&.
    58226#=========  =============  = = ==========================================
    59 create      cifs\.spnego    * * /usr/local/sbin/cifs\.upcall \-c %k
    60 create      dns_resolver   * * /usr/local/sbin/cifs\.upcall %k
    61 .fi
    62 .RE
     227create      cifs\&.spnego    * * /usr/local/sbin/cifs\&.upcall \-c %k
     228create      dns_resolver   * * /usr/local/sbin/cifs\&.upcall %k
     229.EB lightgray adjust-for-leading-newline
     230.if t \{\
     231.sp 1
     232.\}
     233.fi
     234.fam
     235.ps +1
     236.if n \{\
     237.RE
     238.\}
    63239.PP
    64240See
    65241\fBrequest-key.conf5\fR()
    66 for more info on each field\.
     242for more info on each field\&.
    67243.SH "SEE ALSO"
    68244.PP
     
    72248.SH "AUTHOR"
    73249.PP
    74 Igor Mammedov wrote the cifs\.upcall program\.
    75 .PP
    76 Jeff Layton authored this manpage\.
    77 .PP
    78 The maintainer of the Linux CIFS VFS is Steve French\.
     250Igor Mammedov wrote the cifs\&.upcall program\&.
     251.PP
     252Jeff Layton authored this manpage\&.
     253.PP
     254The maintainer of the Linux CIFS VFS is Steve French\&.
    79255.PP
    80256The
    81257Linux CIFS Mailing list
    82 is the preferred place to ask questions regarding these programs\.
     258is the preferred place to ask questions regarding these programs\&.
Note: See TracChangeset for help on using the changeset viewer.