From 8d2d085c8b642662bb22f5a61e7000cf0ecbe25f Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Mon, 5 Dec 2022 20:51:05 +0200 Subject: [PATCH 30/30] Documentation: Add gtk4-client to the client lists Also create a man page link for it. See osdn #46006 Signed-off-by: Marko Lindqvist --- doc/README | 11 ++++++----- doc/man/Makefile.am | 1 + doc/man/freeciv-client.6.in | 17 +++++++++++------ doc/man/freeciv-gtk4.6 | 12 ++++++++++++ doc/man/freeciv.6.in | 3 ++- 5 files changed, 32 insertions(+), 12 deletions(-) create mode 100644 doc/man/freeciv-gtk4.6 diff --git a/doc/README b/doc/README index f8a914c5d4..3a6043af2d 100644 --- a/doc/README +++ b/doc/README @@ -89,14 +89,15 @@ freeciv-gtk3.22: This uses the GTK+ 3 libraries. Version 3.22 or 3.24 as such it is considered to be the default interface throughout the rest of this document. -freeciv-qt: This uses the QT library. Development of this client has recently - reached the state where it's considered generally usable, but it still lacks +freeciv-qt: This uses the QT library, either Qt5 or Qt6. + This client is considered generally usable, but it still lacks number of features gtk-clients have. -freeciv-sdl2: This uses Simple DirectMedia Layer libraries version 2. +freeciv-sdl2: This uses Simple DirectMedia Layer libraries version 2. -freeciv-gtk4: This uses GTK+ 4 libraries. This is development version of - a client to get turned to use gtk4 once it's released. +freeciv-gtk4: This uses GTK 4 libraries. This client is expected later to + replace freeciv-gtk3.22, but it's still lacking some of the functionality + of the freeciv-gtk3.22. Starting a game: diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index d7fa7e0328..c7c55c41c4 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -12,6 +12,7 @@ MAN_PAGES = \ MAN_LINKS = \ freeciv-gtk3.6 \ freeciv-gtk3.22.6 \ + freeciv-gtk4.6 \ freeciv-sdl2.6 \ freeciv-qt.6 \ freeciv-mp-gtk3.6 \ diff --git a/doc/man/freeciv-client.6.in b/doc/man/freeciv-client.6.in index 92a7c607f9..c64fd96d3e 100644 --- a/doc/man/freeciv-client.6.in +++ b/doc/man/freeciv-client.6.in @@ -11,10 +11,10 @@ .\" .TH FREECIV 6 "November 2nd 2016" .SH NAME -freeciv-gtk3, freeciv-gtk3.22, freeciv-sdl2, freeciv-qt \ +freeciv-gtk3, freeciv-gtk3.22, freeciv-gtk4, freeciv-sdl2, freeciv-qt \ \- The clients for the Freeciv game .SH SYNOPSIS -.B freeciv-gtk3|freeciv-gtk3.22|freeciv-sdl2|freeciv-qt \ +.B freeciv-gtk3|freeciv-gtk3.22|freeciv-gtk4|freeciv-sdl2|freeciv-qt \ [ \-A|\-\-Announce \fIprotocol\fP ] \ [ \-a|\-\-autoconnect ] \ [ \-d|\-\-debug \fIlevel\fP ] \ @@ -46,6 +46,11 @@ documentation. It also accepts .B [ \-h|\-\-help ] \ [ \-r|\-\-resolution \fIWIDTHxHEIGHT\fP ] +.B freeciv-gtk4 +accepts the following parameters following \fB\-\-\fP: +.B [ \-h|\-\-help ] \ +[ \-r|\-\-resolution \fIWIDTHxHEIGHT\fP ] + .B freeciv-qt accepts the standard Qt parameters following \fB\-\-\fP; see the Qt documentation. It also accepts @@ -70,12 +75,12 @@ easily one of the most fun and addictive network games out there! This is the client program used to connect to a Freeciv server - see also .IR freeciv-server (6) -\&. \fBfreeciv-gtk3\fP, \fBfreeciv-gtk3.22\fP, \fBfreeciv-qt\fP, and -\fBfreeciv-sdl2\fP +\&. \fBfreeciv-gtk3\fP, \fBfreeciv-gtk3.22\fP, \fBfreeciv-gtk4\fP, +\fBfreeciv-qt\fP, and \fBfreeciv-sdl2\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\fP, \fBfreeciv-gtk3.22\fP, +about using \fBfreeciv-gtk3\fP, \fBfreeciv-gtk3.22\fP, \fBfreeciv-gtk4\fP, \fBfreeciv-sdl2\fP, or \fBfreeciv-qt\fP, see the Client Manual which can be found at .UR @WIKI_URL@ @@ -213,7 +218,7 @@ Print the client-specific parameter help. .TP .BI "\-\- \-r \fIWIDTHxHEIGHT\fP, \-\- \-\-resolution \fIWIDTHxHEIGHT\fP" Behave as if screen resolution were WIDTHxHEIGHT. Only implemented in the -\fBfreeciv-gtk3\fP and \fBfreeciv-gtk3.22\fP clients. +\fBfreeciv-gtk3\fP, \fBfreeciv-gtk3.22\fP, and \fBfreeciv-gtk4\fP clients. .TP .BI "\-\- \-t \fItheme\fP, \-\- \-\-theme \fItheme\fP" Use a particular GUI theme. Only implemented in the diff --git a/doc/man/freeciv-gtk4.6 b/doc/man/freeciv-gtk4.6 new file mode 100644 index 0000000000..7b834993db --- /dev/null +++ b/doc/man/freeciv-gtk4.6 @@ -0,0 +1,12 @@ +.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. +.\" diff --git a/doc/man/freeciv.6.in b/doc/man/freeciv.6.in index 5f72e418e3..a574ee2713 100644 --- a/doc/man/freeciv.6.in +++ b/doc/man/freeciv.6.in @@ -13,7 +13,7 @@ .SH NAME freeciv \- The Freeciv game (overview) .SH SYNOPSIS -.B freeciv-gtk3.22|freeciv-sdl2|freeciv-qt|\ +.B freeciv-gtk3.22|freeciv-gtk4|freeciv-sdl2|freeciv-qt|\ freeciv-\fI[various...]\fP [ options... ] .br .B freeciv-server [ options... ] @@ -116,6 +116,7 @@ Feel free to use it as you wish. .IR freeciv-manual (6) .IR freeciv-gtk3 (6) .IR freeciv-gtk3.22 (6) +.IR freeciv-gtk4 (6) .IR freeciv-qt (6) .IR freeciv-sdl2 (6) .IR freeciv-mp-cli (6) -- 2.35.1