mirrors/weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

man: Document the new 'command input' feature

Browse Source 
Added an entry with examples into the man page and also
into frontend/main.c for the '--help' interface.

Signed-off-by: Nicholas Niro <blowfist@xroutine.net>
This commit is contained in:
Nicholas Niro 2024-01-24 19:55:17 -05:00 committed by Pekka Paalanen
parent 288f552275
commit ab747b7c79
2 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
frontend/main.c
View File

@ -653,11 +653,11 @@ usage(int error_code)
FILE *out = error_code == EXIT_SUCCESS ? stdout : stderr;
fprintf(out,
"Usage: weston [OPTIONS]\n\n"
"Usage: weston [OPTIONS] [-- program [arguments]]\n\n"
"This is weston version " VERSION ", the Wayland reference compositor.\n"
"Weston supports multiple backends, and depending on which backend is in use\n"
"different options will be accepted.\n\n"
"different options will be accepted. When '--' is used, Weston executes\n"
"program when it starts. Weston terminates when the program exits.\n\n"
"Core options:\n\n"
" --version\t\tPrint weston version\n"

17
man/weston.man
View File

@ -366,6 +366,17 @@ The directory for Weston's socket and lock files.
Wayland clients will automatically use this.
.
.\" ***************************************************************
.SH PROGRAM EXECUTION
It is possible to execute a program that will be run by Weston.
.TP
By using this syntax :
weston [options] -- [program [arguments]]
.PP
The '--' here is mandatory to execute a program. There are examples in the
.BR EXAMPLES
section.
.
.\" ***************************************************************
.SH BUGS
Bugs should be reported to
.BR https://gitlab.freedesktop.org/wayland/weston/ "."
@ -384,6 +395,12 @@ weston --xwayland
WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
.IP "From an X terminal, launch Weston with the x11 backend"
weston
.IP "Launch Weston and make it start weston-terminal"
weston -- /usr/local/bin/weston-terminal
.IP "Launch Weston with the kiosk shell and make it start weston-simple-egl"
weston --shell=kiosk-shell.so -- /usr/local/bin/weston-simple-egl
.IP "Launch Weston with the kiosk shell and open a pdf document with mupdf"
weston --shell=kiosk-shell.so -- mupdf /home/user/Documents/krh/wayland.pdf
.
.\" ***************************************************************
.SH "SEE ALSO"