Project

General

Profile

Feature #786 ยป 0021-Document-sdl3-client-in-man-pages.patch

Marko Lindqvist, 08/11/2024 07:24 AM

View differences:

doc/man/Makefile.am
freeciv-gtk3.22.6 \
freeciv-gtk4.6 \
freeciv-sdl2.6 \
freeciv-sdl3.6 \
freeciv-qt.6 \
freeciv-mp-gtk3.6 \
freeciv-mp-gtk4.6 \
doc/man/freeciv-client.6.in
.\"
.TH FREECIV 6 "June 28th 2023"
.SH NAME
freeciv-gtk3.22, freeciv-gtk4, freeciv-sdl2, freeciv-qt \
freeciv-gtk3.22, freeciv-gtk4, freeciv-sdl2, freeciv-sdl3, freeciv-qt \
\- The clients for the Freeciv game
.SH SYNOPSIS
.B freeciv-gtk3.22|freeciv-gtk4|freeciv-sdl2|freeciv-qt \
.B freeciv-gtk3.22|freeciv-gtk4|freeciv-sdl2|freeciv-sdl3|freeciv-qt \
[ \-A|\-\-Announce \fIprotocol\fP ] \
[ \-a|\-\-autoconnect ] \
[ \-d|\-\-debug \fIlevel\fP ] \
......
[ \-s|\-\-swrenderer ] \
[ \-t|\-\-theme \fIstring\fP ]
.B freeciv-sdl3
accepts the following parameters following \fB\-\-\fP:
.B [ \-f|\-\-fullscreen ] \
[ \-F|\-\-Font \fsize\fP ] \
[ \-h|\-\-help ] \
[ \-t|\-\-theme \fIstring\fP ]
.SH DESCRIPTION
Freeciv is a free turn-based multiplayer strategy game, in which each player
becomes the leader of a civilization, fighting to obtain the ultimate goal:
......
This is the client program used to connect to a Freeciv server - see also
.IR freeciv-server (6)
\&. \fBfreeciv-gtk3.22\fP, \fBfreeciv-gtk4\fP, \fBfreeciv-qt\fP, and
\fBfreeciv-sdl2\fP
\&. \fBfreeciv-gtk3.22\fP, \fBfreeciv-gtk4\fP, \fBfreeciv-qt\fP,
\fBfreeciv-sdl2\fP, and \fBfreeciv-sdl3\fP
can also spawn their own local server for single-player games.
This manual page only lists the command line arguments. For more details
about using \fBfreeciv-gtk3.22\fP, \fBfreeciv-gtk4\fP,
\fBfreeciv-sdl2\fP, or \fBfreeciv-qt\fP,
\fBfreeciv-sdl2\fP, \fBfreeciv-sdl3\fP, or \fBfreeciv-qt\fP,
see the Client Manual which can be found at
.UR @HOMEPAGE_URL@
the Freeciv website
......
.TP
.BI "\-\- \-f, \-\- \-\-fullscreen"
Starts the client in full screen mode. Only implemented in the
\fBfreeciv-sdl2\fP client.
\fBfreeciv-sdl2\fP and \fBfreeciv-sdl3\fP clients.
.TP
.BI "\-\- \-h, \-\- \-\-help"
Print the client-specific parameter help.
......
.TP
.BI "\-\- \-t \fItheme\fP, \-\- \-\-theme \fItheme\fP"
Use a particular GUI theme. Only implemented in the
\fBfreeciv-sdl2\fP client.
\fBfreeciv-sdl2\fP and \fBfreeciv-sdl3\fP clients.
.SH "EXAMPLES"
.TP
.B "freeciv-gtk3.22 \-\-name ""King Richard"" \-\-server io.daimi.aau.dk"
Starts the GTK3.22 client using the name \fIKing Richard\fP and connecting
to the server at \fIio.daimi.aau.dk\fP.
.TP
.B freeciv-sdl2 \-a \-t trident
Starts the SDL2-client with the \fItrident\fP tiles and autoconnects to
.B freeciv-sdl3 \-a \-t trident
Starts the SDL3-client with the \fItrident\fP tiles and autoconnects to
\fIlocalhost\fP.
.SH FILES
.TP
doc/man/freeciv-sdl3.6
.so man6/freeciv-client.6
.\" Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2, or (at your option)
.\" any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
meson.build
'freeciv-gtk3.22',
'freeciv-gtk4',
'freeciv-sdl2',
'freeciv-sdl3',
'freeciv-qt',
'freeciv-mp-gtk3',
'freeciv-mp-gtk4',
    (1-1/1)