Return to sd.5 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / isode-beta / others / quipu / uips / sd

Annotation of 43BSDReno/contrib/isode-beta/others/quipu/uips/sd/sd.5, revision 1.1

1.1     ! root        1: .\"$Header: /f/osi/others/quipu/uips/sd/RCS/sd.5,v 7.0 90/06/12 13:14:35 mrose Exp $"
        !             2: .TH SD 5 "16 Jan 1990"
        !             3: .SH NAME
        !             4: sd \- Full-screen directory user agent.
        !             5: .SH SYNOPSIS
        !             6: .B sd
        !             7: .SH DESCRIPTION
        !             8: .PP
        !             9: Read and search calls to the directory in \fIsd\fR are carried out
        !            10: using parameters specified in configuration files contained
        !            11: in a configuration directory.
        !            12: This directory can be held on a per-user basis,
        !            13: and will otherwise default to a system-wide default directory
        !            14: held in the ETCDIR defined during isode installation.
        !            15: These directories are called \*(lq$(HOME)/.duaconfig\*(rq and
        !            16: \*(lq$(ETCDIR)/sd/duaconfig\*(rq respectively.
        !            17: .PP
        !            18: Configuration is trivial in the case of reads,
        !            19: requiring a list of numeric OIDs
        !            20: (one on each line),
        !            21: specifying the attribute types to be read.
        !            22: A sample section of the default configuration file
        !            23: (called readTypes and held in one of the above configuration directories)
        !            24: is,
        !            25: .sp
        !            26: .in +.5i
        !            27: .nf
        !            28: "alias"         2.5.6.1
        !            29: "c"             2.5.4.6
        !            30: "l"             2.5.4.7
        !            31: .fi
        !            32: .in -.5i
        !            33: .sp
        !            34: where the quoted sections
        !            35: (required but always ignored)
        !            36: state the actual name of the type specified and the numeric
        !            37: sections equate to their actual OIDs.
        !            38: .PP
        !            39: Configuration of search is more complicated
        !            40: and is best illustrated by describing the search mechanism used by \fIsd\fR
        !            41: (for information on how to use \fIsd\fR consult section 1c of the manual).
        !            42: Each attribute type in an \fIsd\fR search consists of a 
        !            43: complex filter,
        !            44: that may make use of a number of actual primitive attribute types.
        !            45: Thus a search using the \fIsd\fR type \*(lqPerson\*(rq,
        !            46: as provided in the default configuration set-up,
        !            47: actually corresponds to the filter,
        !            48: .sp
        !            49: .in +.5i
        !            50: .nf
        !            51: objectClass=person AND (  commonName ~= *
        !            52:                        OR surname~= *
        !            53:                        OR title~= *)
        !            54: .fi
        !            55: .in -.5i
        !            56: .sp
        !            57: where '*' means the value supplied at 
        !            58: search-time, '~=' means approximately matches, '%=' means substring matches
        !            59: and '=' means exactly matches.
        !            60: Each of the types used by \fIsd\fR is described in a separate
        !            61: file called \*(lq/filterTypes/Type_whatever\*(rq under
        !            62: one of the configuration directories described above
        !            63: (note that each file name must have the prefix \*(lqType_\*(rq).
        !            64: The set of filter-types provided
        !            65: (Person,
        !            66: Place,
        !            67: Department,
        !            68: Organization)
        !            69: can thus be added to or modified as wished.
        !            70: The precise syntax that must be used is shown in the
        !            71: follwing example,
        !            72: .sp
        !            73: .in +.5i
        !            74: .nf
        !            75: #Composition of type Place
        !            76: name:"Place"
        !            77: ( & ( | (2.5.4.0 = "country")   #"objectClass"
        !            78:         (2.5.4.0 = "room")     # ditto
        !            79:         (2.5.4.0 = "locality")) # ditto
        !            80:     ( | (2.5.4.7 ~= *)                 #"l" - locality
        !            81:         (2.5.4.8 ~= *)         #"stateOrProvinceName"
        !            82:         (2.5.4.6 ~= *)         #"c" - country
        !            83:         (0.9.2342.19200300.100.1.6 ~= *) #"roomNumber"
        !            84:         (2.5.4.3 ~= *)))       #"cn" - "commonName"
        !            85: .fi
        !            86: .in -.5i
        !            87: .sp
        !            88: The first thing to note is that comments begin with a '#'.
        !            89: The rest of the line following a '#' is ignored.
        !            90: The name used by \fIsd\fR to denote the type is
        !            91: specified using the syntax
        !            92: .sp
        !            93: .in +.5i
        !            94: .nf
        !            95: name:"STRING".
        !            96: .fi
        !            97: .in -.5i
        !            98: .sp
        !            99: The following lines describe the filter that the type
        !           100: is composed of.
        !           101: It has a lisp-like syntax and uses symbols that correspond
        !           102: to those used in \fIdish\fR.
        !           103: The points to note are;
        !           104: .sp
        !           105: .in +.5i
        !           106: .nf
        !           107: (1) Each filter or filter-item must be enclosed in brackets.
        !           108: (2) Hard-wired values (as in 2.5.4.0 = "country" above)
        !           109:     must be enclosed in quotes.
        !           110: (3) '*' denotes a value supplied at search time.
        !           111: .fi
        !           112: .in -.5i
        !           113: .sp
        !           114: .PP
        !           115: Additions/modifications may require modification to the \*(lqtypeDefaults\*(rq
        !           116: file.
        !           117: This describes the set of types,
        !           118: chosen from those specified as above,
        !           119: that are available to search with when
        !           120: a specific level of the DIT,
        !           121: e.g. country level,
        !           122: is occupied by the user.
        !           123: In addition it specifies the default type at any level.
        !           124: A typical \*(lqtypeDefaults\*(rq is shown below,
        !           125: .sp
        !           126: .in +.5i
        !           127: .nf
        !           128: #
        !           129: # Format is:
        !           130: #   OID of RDN: Types available at this level: Default type
        !           131: #
        !           132: 2.5.4.10:Person, Place, Department: Person
        !           133: 2.5.4.11:Person, Place, Department: Person
        !           134: 2.5.4.6:Place, Organization:Organization
        !           135: 2.5.4.7:Place, Organization, Department: Organization
        !           136: @: Place: Place
        !           137: .fi
        !           138: .in -.5i
        !           139: .sp
        !           140: Each line,
        !           141: composed of three colon separated fields,
        !           142: specifies defaults for one level of the DIT.
        !           143: The first field contains the numeric OID of an attribute that may be used
        !           144: as an RDN.
        !           145: The root entry,
        !           146: though,
        !           147: is specified by an \*(lq@\*(rq character,
        !           148: as can be seen in the lowermost line.
        !           149: The first line contains the OID for \*(lqorganizationName\*(rq.
        !           150: The second field describes the types that are available to the user
        !           151: at the specified entry type.
        !           152: The third field,
        !           153: which must also be a member of the second field,
        !           154: states the default type available at this level.
        !           155: Thus the first line says that the types Person,
        !           156: Place and Department are available at the orgainzational level,
        !           157: and that the default type given to the user is Person.
        !           158: .SH "SEE ALSO"
        !           159: sd(1c) dish(1c) pod(1c) xd(1c)
        !           160: .br
        !           161: \fIThe ISO Development Environment: User's Manual, Volume 5: QUIPU\fR
        !           162: .br
        !           163: ISO 9594:\fIInformation Processing \-\- Open Systems Interconnection \-\-
        !           164: The Directory\fR
        !           165: .SH AUTHOR
        !           166: [email protected]
        !           167: .br
        !           168: [email protected]

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.