tools: delete -p in ndnsec-export/import help
ndnsec-export and ndnsec-import man pages are also updated.
refs #4313
Change-Id: I1ba41123c5fb46f2e408da3d55dfe9bef56d5b27
diff --git a/docs/conf.py b/docs/conf.py
index 7712d74..f506208 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -242,9 +242,11 @@
('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'part of NDN security tools', None, 1),
('manpages/ndnsec-cert-install', 'ndnsec-cert-instal', 'part of NDN security tools', None, 1),
('manpages/ndnsec-delete', 'ndnsec-delete', 'part of NDN security tools', None, 1),
- ('manpages/ndnsec-export', 'ndnsec-export', 'part of NDN security tools', None, 1),
+ ('manpages/ndnsec-export', 'ndnsec-export',
+ 'export a certificate and its private key to a file', None, 1),
('manpages/ndnsec-get-default', 'ndnsec-get-default', 'part of NDN security tools', None, 1),
- ('manpages/ndnsec-import', 'ndnsec-import', 'part of NDN security tools', None, 1),
+ ('manpages/ndnsec-import', 'ndnsec-import',
+ 'import a certificate and its private key from a file', None, 1),
('manpages/ndnsec-key-gen', 'ndnsec-key-gen', 'part of NDN security tools', None, 1),
('manpages/ndnsec-list', 'ndnsec-list', 'part of NDN security tools', None, 1),
('manpages/ndnsec-set-default', 'ndnsec-set-default', 'part of NDN security tools', None, 1),
diff --git a/docs/manpages/ndnsec-export.rst b/docs/manpages/ndnsec-export.rst
index 839e381..fb3c41f 100644
--- a/docs/manpages/ndnsec-export.rst
+++ b/docs/manpages/ndnsec-export.rst
@@ -1,43 +1,42 @@
ndnsec-export
=============
-``ndnsec-export`` is a tool to export an identity's security data
-
Usage
-----
::
- $ ndnsec-export [-h] [-o output] [-p] identity
+ $ ndnsec-export [-h] [-o output] identity
Description
-----------
-``ndnsec-export`` can export public data of the ``identity`` including default key/certificate.
-``ndnsec-export`` can also export sensitive data (such as private key), but the sensitive data will
-be encrypted. The exported identity can be imported again using ``ndnsec-import``.
-
-By default, the command will write exported data to standard output.
+``ndnsec-export`` exports the default certificate of an identity and its private key as a file. It
+will ask for a passphrase to encrypt the private key. The output file can be imported again with
+``ndnsec-import`` command.
Options
-------
-``-o output``
- Output the exported data to a file pointed by ``output``.
+``-h``
+ Print a help message.
-``-p``
- Export private key of the identity. A password will be asked for data encryption.
+``-o output``
+ Write to an output file instead of the standard output.
+
+``identity``
+ The identity name.
Examples
--------
-Export an identity's security data including private key and store the security data in a file:
+Export an identity's default certificate and private key into a file:
::
- $ ndnsec-export -o id.info -p /ndn/test/alice
+ $ ndnsec-export -o alice.ndnkey /ndn/test/alice
-Export an identity's security data without private key and write it to standard output:
+Export an identity's default certificate and private key to the standard output:
::
diff --git a/docs/manpages/ndnsec-import.rst b/docs/manpages/ndnsec-import.rst
index 5b61f59..fbc8bc9 100644
--- a/docs/manpages/ndnsec-import.rst
+++ b/docs/manpages/ndnsec-import.rst
@@ -1,33 +1,33 @@
ndnsec-import
=============
-``ndnsec-import`` is a tool to import an identity's security data that is prepared by
-``ndnsec-export``.
-
Usage
-----
::
- $ ndnsec-import [-h] [-p] input
+ $ ndnsec-import [-h] input
Description
-----------
-``ndnsec-import`` read data from ``input``. It will ask for password if the input contains private
-key. If ``input`` is ``-``, security data will be read from standard input.
+``ndnsec-import`` imports a certificate and private key from a file created by ``ndnsec-export``. It
+will ask for the passphrase used to encrypt the private key.
Options
-------
-``-p``
- Indicates the imported data containing private key. A password will be asked for data encryption.
+``-h``
+ Print a help message.
+
+``input``
+ Read from an input file. Specify ``-`` to read from the standard input.
Examples
--------
-Import an identity's security data including private key:
+Import a certificate and private key from a file:
::
- $ ndnsec-import -p input_file
+ $ ndnsec-import alice.ndnkey