1Commandline interface
2==================================================
3
4A lot of the Python-RSA functionality is also available as commandline
5scripts. On Linux and other unix-like systems they are executable
6Python scripts, on Windows they are .exe files.
7
8All scripts accept a ``--help`` parameter that give you instructions
9on how to use them. Here is a short overview:
10
11.. index:: CLI interface
12.. index:: pyrsa-keygen, pyrsa-encrypt, pyrsa-decrypt, pyrsa-sign
13.. index:: pyrsa-verify, pyrsa-priv2pub, pyrsa-encrypt-bigfile
14.. index:: pyrsa-decrypt-bigfile, pyrsa-decrypt-bigfile
15
16+-------------------------+--------------------------------------------------+-----------------------------------------+
17| Command                 | Usage                                            | Core function                           |
18+=========================+==================================================+=========================================+
19| pyrsa-keygen            | Generates a new RSA keypair in PEM or DER format | :py:func:`rsa.newkeys`                  |
20+-------------------------+--------------------------------------------------+-----------------------------------------+
21| pyrsa-encrypt           | Encrypts a file. The file must be shorter than   | :py:func:`rsa.encrypt`                  |
22|                         | the key length in order to be encrypted.         |                                         |
23+-------------------------+--------------------------------------------------+-----------------------------------------+
24| pyrsa-decrypt           | Decrypts a file.                                 | :py:func:`rsa.decrypt`                  |
25+-------------------------+--------------------------------------------------+-----------------------------------------+
26| pyrsa-sign              | Signs a file, outputs the signature.             | :py:func:`rsa.sign`                     |
27+-------------------------+--------------------------------------------------+-----------------------------------------+
28| pyrsa-verify            | Verifies a signature. The result is written to   | :py:func:`rsa.verify`                   |
29|                         | the console as well as returned in the exit      |                                         |
30|                         | status code.                                     |                                         |
31+-------------------------+--------------------------------------------------+-----------------------------------------+
32| pyrsa-priv2pub          | Reads a private key and outputs the              | \-                                      |
33|                         | corresponding public key.                        |                                         |
34+-------------------------+--------------------------------------------------+-----------------------------------------+
35| *pyrsa-encrypt-bigfile* | *Encrypts a file to an encrypted VARBLOCK file.  | *Deprecated in Python-RSA 3.4 and       |
36|                         | The file can be larger than the key length, but  | removed from version 4.0.*              |
37|                         | the output file is only compatible with          |                                         |
38|                         | Python-RSA.*                                     |                                         |
39+-------------------------+--------------------------------------------------+-----------------------------------------+
40| *pyrsa-decrypt-bigfile* | *Decrypts an encrypted VARBLOCK file.*           | *Deprecated in Python-RSA 3.4 and       |
41|                         |                                                  | removed from version 4.0.*              |
42+-------------------------+--------------------------------------------------+-----------------------------------------+
43