docs: refresh installation instructions and general cleanup
Change-Id: Ibfe945887e5cad979c1f9a78fd5a3062bb20a8b5
diff --git a/docs/manpages/ndn-client.conf.rst b/docs/manpages/ndn-client.conf.rst
index d267c14..62f42ca 100644
--- a/docs/manpages/ndn-client.conf.rst
+++ b/docs/manpages/ndn-client.conf.rst
@@ -5,8 +5,8 @@
The configuration file ``client.conf`` is looked up in several directories in the following order:
-- ``$HOME/.ndn/``: user-specific settings
-- ``@SYSCONFDIR@/ndn/`` (``/usr/local/etc/ndn``, ``/opt/local/etc/ndn``, or other, depending how the
+- ``$HOME/.ndn``: user-specific settings
+- ``@SYSCONFDIR@/ndn`` (``/usr/local/etc/ndn``, ``/opt/local/etc/ndn``, or other, depending how the
library is configured): system-wide settings
- ``/etc/ndn``: default system-wide settings
@@ -24,9 +24,10 @@
By default, ``unix:///var/run/nfd.sock`` is used.
- ..note::
+ .. note::
This value can be overridden using the ``NDN_CLIENT_TRANSPORT`` environment variable.
+
Key Management
--------------
@@ -55,10 +56,10 @@
rm -rf ~/.ndn/ndnsec-*
- It's not recommended to share the same directory between machines, e.g. via NFS.
+ It is not recommended to share the same directory between machines, e.g. via NFS.
Simultaneous access from multiple machines may cause errors.
- ..note::
+ .. note::
This value can be overridden using the ``NDN_CLIENT_PIB`` environment variable.
tpm
@@ -69,15 +70,15 @@
Possible values for ``[scheme]``:
- * ``tpm-osx-keychain`` (default on OS X platform): secure storage of private keys in OS X
+ * ``tpm-osx-keychain`` (default on macOS): secure storage of private keys in the macOS
Keychain with OS-provided access restrictions.
``[location]`` parameter is ignored.
- May not work for daemon applications, as user interaction may be required to access OS X
- Keychain.
+ May not work for daemon applications, as user interaction may be required to access the
+ macOS Keychain.
- * ``tpm-file`` (default on all other platforms): file-based storage of private keys
+ * ``tpm-file`` (default on all other platforms): file-based storage of private keys.
Possible values for ``[location]``:
@@ -90,11 +91,11 @@
tpm=tpm-file
- **Change of ``tpm`` setting is only possible together with ``pib`` setting. Otherwise, an
- error will be generated during PIB/TPM access**
+ **Changing the ``tpm`` setting is only possible together with ``pib`` setting. Otherwise,
+ an error will be generated during PIB/TPM access.**
- It's not recommended to share the same directory between machines, e.g. via NFS.
+ It is not recommended to share the same directory between machines, e.g. via NFS.
Simultaneous access from multiple machines may cause errors.
- ..note::
+ .. note::
This value can be overridden using the ``NDN_CLIENT_TPM`` environment variable.