Add manpage.

This commit is contained in:
Antoine POPINEAU 2021-07-05 09:09:41 +02:00
parent 93a6456860
commit a64543f30c
No known key found for this signature in database
GPG Key ID: A78AC64694F84063
2 changed files with 81 additions and 0 deletions

1
.gitignore vendored
View File

@ -1 +1,2 @@
/target
/contrib/man/*.roff

View File

@ -0,0 +1,80 @@
tuigreet(1)
# NAME
tuigreet - A graphical console greeter for greetd
# SYNOPSIS
*tuigreet* [OPTIONS]...
# OPTIONS
*-h, --help*
Show usage and exit.
*-v, --version*
Print program version and exit.
*-c, --cmd CMD*
Specify which command to run on successful authentication. This can be
overriden by manual selection within *tuigreet*.
*-s, --sessions DIR1[:DIR2]...*
Location of desktop-files to be used as session definitions. By default,
sessions are fetched from */usr/share/xsessions* and
*/usr/share/wayland-sessions*.
*-w, --width COLS*
Number of columns the main prompt area should take on the screen.
*-i, --issue*
Print the content of */etc/issue* at the top of the prompt area.
This option is mutually exclusive with *--greeting*.
*-g, --greeting GREETING*
Specify the text to be displayed at the top of the prompt area.
This option is mutually exclusive with *--issue*.
*-t, --time*
Print the current date and time at the top of the screen.
*-r, --remember*
Remember the username of the last successfully opened session, so the
username field will be pre-filled on the next run.
*--remember-session*
Remember the last selected session, effectively overriding the given *--cmd*
option on subsequent runs.
*--asterisks*
Add visual feedback when typing secrets, as one asterisk character for every
keystroke. By default, no feedback is given at all.
*--asterisks-char CHAR*
Change the default feedback character from an asterisk to the provided
character.
*--window-padding COLS*
Add spacing between the edge of the screen area the drawing area.
*--container-padding COLS*
Add spacing between the border of the main prompt area and its contents.
*--prompt-padding ROWS*
Add spacing between form fields.
# AUTHORS
Maintained by Antoine POPINEAU <antoine@popineau.eu>.
# DEVELOPMENT
Issue reporting and development discussion should happen at
https://github.com/apognu/tuigreet.
# SEE ALSO
*greetd*(1)