| 1 |
.TH AusweisApp 1 |
| 2 |
.SH NAME |
| 3 |
AusweisApp \- Official authentication app for German ID cards and residence permits |
| 4 |
.SH SYNOPSIS |
| 5 |
|
| 6 |
AusweisApp [-h|--help] |
| 7 |
.br |
| 8 |
AusweisApp [--help-all] |
| 9 |
.br |
| 10 |
AusweisApp [-v|--version] |
| 11 |
.br |
| 12 |
AusweisApp [--show] |
| 13 |
.br |
| 14 |
AusweisApp |
| 15 |
[--keep] |
| 16 |
[--no-logfile] |
| 17 |
[--no-loghandler] |
| 18 |
[--show] |
| 19 |
[--no-proxy] |
| 20 |
[--ui { qml|websocket }] |
| 21 |
[--port \fI\,PORT\/\fR] |
| 22 |
[--address \fI\,ADDRESS\/\fR] |
| 23 |
|
| 24 |
.SH DESCRIPTION |
| 25 |
AusweisApp allows you to authenticate yourself against websites via your German |
| 26 |
ID card and residence permits. |
| 27 |
|
| 28 |
You will need: |
| 29 |
.br |
| 30 |
* an ID card that is enabled for online identification |
| 31 |
.br |
| 32 |
* A compatible NFC device (most NFC readers should work, NFC-enabled phones can |
| 33 |
* also be used) |
| 34 |
.br |
| 35 |
* AusweisApp |
| 36 |
.br |
| 37 |
* A browser |
| 38 |
.br |
| 39 |
* A website that supports authentication via German ID card |
| 40 |
|
| 41 |
When you visit such a website, AusweisApp will be triggered and will ask you if |
| 42 |
you want to authenticate against the website. |
| 43 |
|
| 44 |
This program will provide a local webserver for your browser to interface against. |
| 45 |
|
| 46 |
.SH OPTIONS |
| 47 |
|
| 48 |
.TP |
| 49 |
.B -h, --help |
| 50 |
Displays a short help message. |
| 51 |
|
| 52 |
.TP |
| 53 |
.B --help-all |
| 54 |
Displays help including Qt specific options. |
| 55 |
|
| 56 |
.TP |
| 57 |
.B -v, --version |
| 58 |
Displays version information. |
| 59 |
|
| 60 |
.TP |
| 61 |
.B --keep |
| 62 |
.br |
| 63 |
By default, AusweisApp writes a log to a file matching |
| 64 |
${TMP}/AusweisApp.*.log. When the program terminates, it will be deleted. This |
| 65 |
setting prevents deletion. |
| 66 |
|
| 67 |
.TP |
| 68 |
.B --no-logfile |
| 69 |
Suppress writing a log file to ${TMP}/AusweisApp.*.log. Logs will still be |
| 70 |
written to STDOUT. |
| 71 |
|
| 72 |
.TP |
| 73 |
.B --no-loghandler |
| 74 |
Disable default log handler. This disables logging to STDOUT. |
| 75 |
|
| 76 |
.TP |
| 77 |
.B --show |
| 78 |
Show window on startup. |
| 79 |
|
| 80 |
.TP |
| 81 |
.B --no-proxy |
| 82 |
Disable system proxy. |
| 83 |
|
| 84 |
.TP |
| 85 |
.B --ui { qml|webservice|websocket } |
| 86 |
This option allows multiple values. |
| 87 |
- "qml" will start the program with a visible UI. |
| 88 |
- "websocket" will let it start in the background as an SDK. This is only useful when integrating |
| 89 |
AusweisApp into other programs. |
| 90 |
- "webservice" starts listening on given port/address. |
| 91 |
|
| 92 |
Default is "qml,webservice,websocket". |
| 93 |
|
| 94 |
.TP |
| 95 |
.B --port \fI\,PORT\/\fR |
| 96 |
Change the listening port for the WebSocket. Default is 24727. Selecting "0" is |
| 97 |
a special case. AusweisApp will then select a random port and write the port |
| 98 |
number to a file in ${TMP}/AusweisApp.<PID>.port. |
| 99 |
|
| 100 |
.TP |
| 101 |
.B --address \fI\,ADDRESS\/\fR |
| 102 |
Use given addresses for interface binding. Normally AusweisApp is bound to |
| 103 |
localhost only as it is a security requirement. Useful for testing only. |
| 104 |
This option allows multiple values. |
| 105 |
|
| 106 |
.SH "RETURN VALUE" |
| 107 |
AusweisApp will return 0 when successfully terminated. |
| 108 |
.SH ENVIRONMENT |
| 109 |
.TP |
| 110 |
.B QT_QPA_PLATFORM={ wayland|X11 } |
| 111 |
You may force the session type to wayland or X11. This is only needed for |
| 112 |
debugging purposes. XDG_SESSION_TYPE will be ignored on gnome. |
| 113 |
|
| 114 |
.SH FILES |
| 115 |
|
| 116 |
\fI~/.config/AusweisApp_CE/AusweisApp2.conf\fR |
| 117 |
File path where the user config is saved. |
| 118 |
|
| 119 |
.SH CAVEATS |
| 120 |
Currently there is no way to terminate the program on gnome as the TrayIcon |
| 121 |
is mandatory. |
| 122 |
|
| 123 |
.SH AUTHOR |
| 124 |
This man page was written by Lee Garrett ([email protected]) for Debian (but |
| 125 |
may be used by others). |
| 126 |
|
| 127 |
.SH "SEE ALSO" |
| 128 |
https://www.ausweisapp.bund.de/en |
| 129 |
.br |
| 130 |
https://www.ausweisapp.bund.de/sdk |