From: Björn Baumbach Date: Thu, 28 Mar 2019 19:39:41 +0000 (+0100) Subject: doc: add documentation for "samba-tool" contact management X-Git-Tag: ldb-2.0.5~10 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=cbf074d7d5198158279929c19d582de9a340f782;p=thirdparty%2Fsamba.git doc: add documentation for "samba-tool" contact management Signed-off-by: Björn Baumbach Reviewed-by: Andrew Bartlett --- diff --git a/docs-xml/manpages/samba-tool.8.xml b/docs-xml/manpages/samba-tool.8.xml index eb7744b8f84..c09e922e4f4 100644 --- a/docs-xml/manpages/samba-tool.8.xml +++ b/docs-xml/manpages/samba-tool.8.xml @@ -217,6 +217,192 @@ + + contact + Manage contacts. + + + + contact create [<replaceable>contactname</replaceable>] [options] + Create a new contact in the Active Directory Domain. + The name of the new contact can be specified by the first + argument 'contactname' or the --given-name, --initial and --surname + arguments. If no 'contactname' is given, contact's name will be made + up of the given arguments by combining the given-name, initials and + surname. Each argument is optional. A dot ('.') will be appended to + the initials automatically. + + + + --ou=OU + + DN of alternative location (with or without domainDN counterpart) in + which the new contact will be created. + E.g. 'OU=OUname'. + Default is the domain base. + + + + + --description=DESCRIPTION + + The new contacts's description. + + + + + --surname=SURNAME + + Contact's surname. + + + + + --given-name=GIVEN_NAME + + Contact's given name. + + + + + --initials=INITIALS + + Contact's initials. + + + + + --display-name=DISPLAY_NAME + + Contact's display name. + + + + + --job-title=JOB_TITLE + + Contact's job title. + + + + + --department=DEPARTMENT + + Contact's department. + + + + + --company=COMPANY + + Contact's company. + + + + + --mail-address=MAIL_ADDRESS + + Contact's email address. + + + + + --internet-address=INTERNET_ADDRESS + + Contact's home page. + + + + + --telephone-number=TELEPHONE_NUMBER + + Contact's phone number. + + + + + --mobile-number=MOBILE_NUMBER + + Contact's mobile phone number. + + + + + --physical-delivery-office=PHYSICAL_DELIVERY_OFFICE + + Contact's office location. + + + + + + + + contact delete <replaceable>contactname</replaceable> [options] + Delete an existing contact. + The contactname specified on the command is the common name or the + distinguished name of the contact object. The distinguished name of the + contact can be specified with or without the domainDN component. + + + + contact edit <replaceable>contactname</replaceable> + Modify a contact AD object. + The contactname specified on the command is the common name or the + distinguished name of the contact object. The distinguished name of the + contact can be specified with or without the domainDN component. + + + + --editor=EDITOR + + Specifies the editor to use instead of the system default, or 'vi' if no + system default is set. + + + + + + + contact list [options] + List all contacts. + + + + --full-dn + + Display contact's full DN instead of the name. + + + + + + + contact move <replaceable>contactname</replaceable> <replaceable>new_parent_dn</replaceable> [options] + This command moves a contact into the specified organizational + unit or container. + The contactname specified on the command is the common name or the + distinguished name of the contact object. The distinguished name of the + contact can be specified with or without the domainDN component. + + + + contact show <replaceable>contactname</replaceable> [options] + Display a contact AD object. + The contactname specified on the command is the common name or the + distinguished name of the contact object. The distinguished name of the + contact can be specified with or without the domainDN component. + + + + --attributes=CONTACT_ATTRS + + Comma separated list of attributes, which will be printed. + + + + + dbcheck Check the local AD database for errors.