diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2017-10-11 22:37:10 +0200 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2017-10-11 22:37:10 +0200 |
| commit | 4c5e04612937c95409056818c13f60e1221a773a (patch) | |
| tree | ed3962355d18926a91129b35c1f8e7fd2a22f25c | |
| parent | 25cb2fc2e55147ad6b7a4a8a0754d972448a13a9 (diff) | |
Add a manual page for pskc2csv
| -rw-r--r-- | docs/conf.py | 6 | ||||
| -rw-r--r-- | docs/pskc2csv.rst | 65 | ||||
| -rw-r--r-- | setup.cfg | 3 |
3 files changed, 70 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 2487640..41c53f7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -173,7 +173,7 @@ html_show_sourcelink = False #html_file_suffix = None # Suffix for generated links to HTML files. -#html_link_suffix = '' +html_link_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'python-pskcdoc' @@ -184,11 +184,11 @@ htmlhelp_basename = 'python-pskcdoc' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'python-pskc', u'python-pskc Documentation', + ('pskc2csv', 'pskc2csv', u'Convert a PSKC file to CSV', [u'Arthur de Jong'], 1) ] # If true, show URL addresses after external links. -#man_show_urls = False +man_show_urls = True intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/pskc2csv.rst b/docs/pskc2csv.rst new file mode 100644 index 0000000..4602121 --- /dev/null +++ b/docs/pskc2csv.rst @@ -0,0 +1,65 @@ +:orphan: + +pskc2csv +======== + +Synopsis +-------- + +**pskc2csv** [*options*] <*FILE*> + +Description +----------- + +:program:`pskc2csv` reads a PSKC file, optionally decrypts any encrypted key +material and outputs a CSV file with information from the PSKC file. + +Options +------- + +.. program:: pskc2csv + +.. option:: -h, --help + + Display usage summary. + +.. option:: -V, --version + + Display version information. + +.. option:: -o FILE, --output FILE + + By default :program:`pskc2csv` writes a CSV file to stdout. This option + can be used to save the CSV to a file instead. + +.. option:: -c COL:LABEL,COL,.., --columns COL:LABEL,COL,.. + + Specify the columns that should be written to the CSV file. Any + property of :class:`~pskc.key.Key` instances can be used as well + as :class:`~pskc.policy.Policy` properties via ``policy``. + + For example: ``serial``, ``secret``, ``counter``, ``time_offset``, + ``time_interval``, ``interval``, ``time_drift``, ``issuer``, + ``manufacturer``, ``response_length``, ``policy.pin_min_length``. + + By default ``serial,secret,algorithm,response_length,time_interval`` is + used. + + The column can be followed by an optional label to use in the CSV file in + place of the column specification. + +.. option:: -p PASS/FILE, --password PASS/FILE, --passwd PASS/FILE + + The password to use for decryption. If the argument refers to a file the + password is read from the file instead. + +.. option:: -s KEY/FILE, --secret KEY/FILE + + A hex encoded encryption key or a file containing the binary (raw data, + not encoded) key. + +.. option:: -e ENCODING, --secret-encoding ENCODING + + Specify the encoding to use for writing key material to the CSV file. By + default HEX encoding is used. Valid encodings are: ``base32``, ``base64`` + or ``hex``. @@ -16,7 +16,8 @@ cover-html-dir=coverage cover-min-percentage=100 [build_sphinx] -all_files = 1 +all_files = 1 +builder = html,man [flake8] ignore = D101,D102,D105,D107,D202,D205,D209,D400,N806 |