summaryrefslogtreecommitdiff
path: root/manpages/libeufin-bank.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'manpages/libeufin-bank.1.rst')
-rw-r--r--manpages/libeufin-bank.1.rst185
1 files changed, 185 insertions, 0 deletions
diff --git a/manpages/libeufin-bank.1.rst b/manpages/libeufin-bank.1.rst
new file mode 100644
index 00000000..77bc1104
--- /dev/null
+++ b/manpages/libeufin-bank.1.rst
@@ -0,0 +1,185 @@
+libeufin-bank(1)
+#################
+
+.. only:: html
+
+ Name
+ ====
+
+ **libeufin-bank** - LibEuFin Bank
+
+
+Synopsis
+========
+
+**libeufin-bank**
+[**-h** | **--help**]
+[**--version**]
+COMMAND [ARGS...]
+
+Subcommands: **serve**, **dbinit**, **create-account**, **passwd**, **gc**,
+**config**
+
+
+Description
+===========
+
+**libeufin-bank** is a program that implements a simple core banking system with
+account and REST APIs, including REST APIs for a Web interface
+and REST APIs to interact with GNU Taler components.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+
+**–version**
+ Print version information.
+
+The interaction model is as follows:
+
+- Configure the database with commands ``dbinit``.
+
+- Set admin account password with commands ``passwd``.
+
+- Start the HTTP server with command ``serve``.
+ Let this run in a shell, writing logs to stderr.
+
+The following sections describe each command in detail.
+
+dbinit
+------
+
+This command defines the database schema for LibEuFin Bank. It is mandatory to run this command before invoking the ``serve`` command.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ If present, deletes any database table (WARNING: potential data loss)
+
+
+serve
+-----
+
+This command starts the HTTP server.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+
+create-account
+--------------
+
+This command create a bank account and prints its payto://-URI to STDOUT.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-u** \| **--username** *USERNAME*
+ Account unique username.
+**-p** \| **--password** *PASSWORD*
+ Account password used for authentication.
+**--name** *NAME*
+ Legal name of the account owner.
+**--public**
+ Make this account visible to anyone.
+**--exchange**
+ Make this account a taler exchange.
+**--email** *EMAIL*
+ E-Mail address used for TAN transmission.
+**--phone** *PHONE_NUMBER*
+ Phone number used for TAN transmission.
+**--cashout_payto_uri** *PAYTO_URI*
+ Payto URI of a fiant account who receive cashout amount.
+**--payto_uri** *PAYTO_URI*
+ Payto URI of this account.
+**--debit_threshold** *AMOUNT*
+ Max debit allowed for this account.
+
+
+edit-account
+--------------
+
+This command edit an existing account.
+
+It takes one argument, the account username.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--name** *NAME*
+ Legal name of the account owner.
+**--public** *true|false*
+ Make this account visible to anyone.
+**--email** *EMAIL*
+ E-Mail address used for TAN transmission.
+**--phone** *PHONE_NUMBER*
+ Phone number used for TAN transmission.
+**--cashout_payto_uri** *PAYTO_URI*
+ Payto URI of this account.
+**--debit_threshold** *AMOUNT*
+ Max debit allowed for this account.
+
+passwd
+------
+
+This command change any account password.
+
+It takes two arguments, the account username and the account new password.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+
+gc
+--
+
+This command performs garbage collection: abort expired operations and clean expired data, etc.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+
+.. include:: ../frags/libeufin-config-cli.rst
+
+
+SEE ALSO
+========
+
+libeufin-bank.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.