bin/pkcs11/pkcs11-list.docbook

	pkcs11-list.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
486N/A<!--
486N/A - Copyright (C) 2009, 2014, 2015  Internet Systems Consortium, Inc. ("ISC")
486N/A -
486N/A - Permission to use, copy, modify, and/or distribute this software for any
943N/A - purpose with or without fee is hereby granted, provided that the above
486N/A - copyright notice and this permission notice appear in all copies.
486N/A -
919N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
919N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
919N/A - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
919N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
919N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
919N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
919N/A - PERFORMANCE OF THIS SOFTWARE.
919N/A-->
919N/A
919N/A<!-- Converted by db4-upgrade version 1.0 -->
919N/A<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-list">
919N/A  <info>
919N/A    <date>2009-10-05</date>
919N/A  </info>
919N/A  <refentryinfo>
919N/A    <corpname>ISC</corpname>
919N/A    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
486N/A  </refentryinfo>
486N/A
486N/A  <refmeta>
486N/A    <refentrytitle><application>pkcs11-list</application></refentrytitle>
493N/A    <manvolnum>8</manvolnum>
486N/A    <refmiscinfo>BIND9</refmiscinfo>
486N/A  </refmeta>
493N/A
486N/A  <refnamediv>
911N/A    <refname><application>pkcs11-list</application></refname>
911N/A    <refpurpose>list PKCS#11 objects</refpurpose>
911N/A  </refnamediv>
911N/A
486N/A  <docinfo>
486N/A    <copyright>
486N/A      <year>2009</year>
486N/A      <year>2014</year>
486N/A      <year>2015</year>
493N/A      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
493N/A    </copyright>
486N/A  </docinfo>
486N/A
  <refsynopsisdiv>
    <cmdsynopsis sepchar=" ">
      <command>pkcs11-list</command>
      <arg choice="opt" rep="norepeat"><option>-P</option></arg>
      <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
      <arg choice="opt" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
      <arg choice="opt" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
      <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection><info><title>DESCRIPTION</title></info>

    <para>
      <command>pkcs11-list</command>
      lists the PKCS#11 objects with <option>ID</option> or
      <option>label</option> or by default all objects.
    </para>
  </refsection>

  <refsection><info><title>ARGUMENTS</title></info>

    <variablelist>
      <varlistentry>
        <term>-P</term>
        <listitem>
          <para>
            List only the public objects. (Note that on some PKCS#11
            devices, all objects are private.)
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-m <replaceable class="parameter">module</replaceable></term>
        <listitem>
          <para>
            Specify the PKCS#11 provider module.  This must be the full
            path to a shared library object implementing the PKCS#11 API
            for the device.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-s <replaceable class="parameter">slot</replaceable></term>
        <listitem>
          <para>
            Open the session with the given PKCS#11 slot.  The default is
            slot 0.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-i <replaceable class="parameter">ID</replaceable></term>
        <listitem>
          <para>
            List only key objects with the given object ID.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-l <replaceable class="parameter">label</replaceable></term>
        <listitem>
          <para>
            List only key objects with the given label.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-p <replaceable class="parameter">PIN</replaceable></term>
        <listitem>
          <para>
            Specify the PIN for the device.  If no PIN is provided on the
            command line, <command>pkcs11-list</command> will prompt for it.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection><info><title>SEE ALSO</title></info>

    <para>
      <citerefentry>
        <refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsection>

</refentry>