'\" t
.\"     Title: aqhbci-tool4
.\"    Author: Micha Lenk
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-05-30
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "AQHBCI\-TOOL4" "1" "2024-05-30" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
aqhbci-tool4 \- Command line tools for setup, modification and debugging of HBCI settings.
.SH "SYNOPSIS"
.sp
\fIaqhbci\-tool4\fP [global options] <command> [command options]
.SH "DESCRIPTION"
.sp
The aqhbci\-tool4(1) command can be used to setup and manage AqBanking\(cqs HBCI users, customers and accounts.
.SH "OPTIONS"
.sp
Two common options need to be distinguished carefully from each
other: "\-c CUSTOMER_ID" refers to the German "Kunden\-ID" or
"Kundennummer". "\-u USER_ID" refers to the German
"Benutzerkennung". If your bank has specified both to you, you
need to check carefully not to confuse one with the other.
.sp
This is version 6.5.10
.sp
\-D PARAM, \-\-cfgdir=PARAM
.RS 4
Specify the configuration folder
.RE
.sp
\-n, \-\-noninteractive
.RS 4
Select non\-interactive mode.
This automatically returns a confirmative answer to any non\-critical
message.
.RE
.sp
\-A, \-\-acceptvalidcerts
.RS 4
Automatically accept all valid TLS certificate
.RE
.sp
\-\-charset=PARAM
.RS 4
Specify the output character set
.RE
.sp
\-P PARAM, \-\-pinfile=PARAM
.RS 4
Specify the PIN file
.RE
.sp
\-\-opticaltan=PARAM
.RS 4
Specify an external tool to display optical TAN challenges
.RE
.sp
\-h, \-\-help
.RS 4
Show this help screen. For help on commands, run aqbanking\-cli <COMMAND> \-\-help.
.RE
.SH "COMMANDS"
.sp
mkpinlist
.RS 4
This command creates an empty PIN file
.RE
.sp
adduser
.RS 4
Adds a user (\(-> setup HBCI for a bank)
.RE
.sp
deluser
.RS 4
Deletes a user.
.RE
.sp
getkeys
.RS 4
Requests the server\(cqs key
.RE
.sp
getcert
.RS 4
Requests the server\(cqs SSL certificate
.RE
.sp
createkeys
.RS 4
Create user keys.
.RE
.sp
sendkeys
.RS 4
Send the user keys to the bank.
.RE
.sp
changekeys
.RS 4
Change user keys (and media).
.RE
.sp
getbankinfo
.RS 4
Request bank information
.RE
.sp
getaccounts
.RS 4
Requests account list for a user
.RE
.sp
getaccsepa
.RS 4
Requests SEPA account list for a user
.RE
.sp
gettargetacc
.RS 4
Requests target account list for a user
.RE
.sp
getsysid
.RS 4
Requests a system id for the given user
.RE
.sp
getitanmodes
.RS 4
Requests supported iTAN modes for the given user
.RE
.sp
listitanmodes
.RS 4
Show a list of supported iTAN modes for the given user
.RE
.sp
setitanmode
.RS 4
Select an iTAN mode for the given user
.RE
.sp
listusers
.RS 4
List the users
.RE
.sp
listaccounts
.RS 4
List the accounts
.RE
.sp
changepin
.RS 4
Change the PIN of a key file
.RE
.sp
unblockpin
.RS 4
Unblock the PIN in PIN TAN mode.
.RE
.sp
iniletter
.RS 4
Print the INI letter for a given user
.RE
.sp
addaccount
.RS 4
Manually add account
.RE
.sp
delaccount
.RS 4
Deletes account
.RE
.sp
sethbciversion
.RS 4
Set the HBCI protocol version to be used
.RE
.sp
setMaxTransfers
.RS 4
Set the maximum number of transfers/debit notes per job
.RE
.sp
setsepaprofile
.RS 4
Set the SEPA profile for transfers/debit notes
.RE
.sp
setTanMediumId
.RS 4
Set the medium id for some PIN/TAN methods (like mTAN)
.RE
.sp
setTanMechanism
.RS 4
Overwrite TAN mechanism to use
.RE
.sp
adduserflags
.RS 4
Set special flags for the given user
.RE
.sp
subuserflags
.RS 4
Unset special flags for the given user
.RE
.sp
addaccountflags
.RS 4
Set special flags for the given account
.RE
.sp
subaccountflags
.RS 4
Reset special flags for the given account
.RE
.sp
logfile
.RS 4
Make an AqBanking log file anonymous
.RE
.sp
versions
.RS 4
Print the program and library versions
.RE
.sp
For help on options available to specific commands, run aqhbci\-tool4 <COMMAND> \-\-help.
.SH "FILES"
.sp
$HOME/.aqbanking/
.RS 4
All files in this directory are part of the AqBanking configuration.
Even though mostly all files are in a simple plaintext syntax, you
MUST NOT change anything in here without using the tools or libraries
provided by AqBanking, except you know exactly what you are doing.
Those files may be subject to changes in future AqBanking releases.
.RE
.SH "BUGS"
.sp
Probably lots, please post them to the mailing list (see Resources below)
or file an issue in the \c
.URL "https://www.aquamaniac.de/rdm/projects/aqbanking/issues" "issue tracker"
when you find them.
.SH "RESOURCES"
.sp
The \c
.URL "https://www.aquamaniac.de/rdm/projects/aqbanking/wiki" "AqBanking wiki"
provides useful help for setting up AqBanking, even though it is only available
in German.
On the \c
.URL "https://mailman.aqbanking.de/listinfo/aqbanking\-user" "AqBanking mailing lists"
you can give kudos to the developers or get your questions answered.
.SH "COPYING"
.sp
Copyright (C) Martin Preuß.
Free use of this software is granted under the terms of the GNU General
Public License (GPL).
.sp
The manpage was composed by Micha Lenk and converted by the nifty tool
AsciiDoc into a manpage.
.SH "AUTHOR"
.sp
Micha Lenk