sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
Code

doc: add documentation for "samba-tool" contact management

Browse Source 
Signed-off-by: Björn Baumbach <bb@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
This commit is contained in:
Björn Baumbach 2019-03-28 20:39:41 +01:00 committed by Andrew Bartlett
parent 78e78a4092
commit cbf074d7d5
1 changed files with 186 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
docs-xml/manpages/samba-tool.8.xml
View File

@ -217,6 +217,192 @@
</variablelist>
</refsect3>
<refsect2>
<title>contact</title>
<para>Manage contacts.</para>
</refsect2>
<refsect3>
<title>contact create [<replaceable>contactname</replaceable>] [options]</title>
<para>Create a new contact in the Active Directory Domain.</para>
<para>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.</para>
<variablelist>
<varlistentry>
<term>--ou=OU</term>
<listitem><para>
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--description=DESCRIPTION</term>
<listitem><para>
The new contacts's description.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--surname=SURNAME</term>
<listitem><para>
Contact's surname.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--given-name=GIVEN_NAME</term>
<listitem><para>
Contact's given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--initials=INITIALS</term>
<listitem><para>
Contact's initials.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--display-name=DISPLAY_NAME</term>
<listitem><para>
Contact's display name.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--job-title=JOB_TITLE</term>
<listitem><para>
Contact's job title.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--department=DEPARTMENT</term>
<listitem><para>
Contact's department.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--company=COMPANY</term>
<listitem><para>
Contact's company.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--mail-address=MAIL_ADDRESS</term>
<listitem><para>
Contact's email address.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--internet-address=INTERNET_ADDRESS</term>
<listitem><para>
Contact's home page.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--telephone-number=TELEPHONE_NUMBER</term>
<listitem><para>
Contact's phone number.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--mobile-number=MOBILE_NUMBER</term>
<listitem><para>
Contact's mobile phone number.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--physical-delivery-office=PHYSICAL_DELIVERY_OFFICE</term>
<listitem><para>
Contact's office location.
</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3>
<title>contact delete <replaceable>contactname</replaceable> [options]</title>
<para>Delete an existing contact.</para>
<para>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.</para>
</refsect3>
<refsect3>
<title>contact edit <replaceable>contactname</replaceable></title>
<para>Modify a contact AD object.</para>
<para>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.</para>
<variablelist>
<varlistentry>
<term>--editor=EDITOR</term>
<listitem><para>
Specifies the editor to use instead of the system default, or 'vi' if no
system default is set.
</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3>
<title>contact list [options]</title>
<para>List all contacts.</para>
<variablelist>
<varlistentry>
<term>--full-dn</term>
<listitem><para>
Display contact's full DN instead of the name.
</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3>
<title>contact move <replaceable>contactname</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
<para>This command moves a contact into the specified organizational
unit or container.</para>
<para>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.</para>
</refsect3>
<refsect3>
<title>contact show <replaceable>contactname</replaceable> [options]</title>
<para>Display a contact AD object.</para>
<para>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.</para>
<variablelist>
<varlistentry>
<term>--attributes=CONTACT_ATTRS</term>
<listitem><para>
Comma separated list of attributes, which will be printed.
</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect2>
<title>dbcheck</title>
<para>Check the local AD database for errors.</para>