From 26a87e468c5eecee7fcdcde90c783c51a8dd1685 Mon Sep 17 00:00:00 2001 From: Jim DeLaHunt Date: Tue, 11 May 2021 23:50:02 -0700 Subject: [PATCH] Create a new man page "freeciv", fixes ticket 42138 Create a man page, with source in doc/man/freeciv.6.in . Content and structure are both adapted from doc/man/freeciv-{client,server}.6.in . This page gives an overview of the Freeciv game, including its client and server parts and its flexible rulesets and parameters. It points the reader to the other man pages and websites for detailed information. The problem which this page solves is that a user new to Freeciv, unsure where to start, can type the obvious thing, "man freeciv", and get a useful overview instead of finding nothing. Make changes to ancillary files to incorporate the new source file. All these changes are parallel to corresponding entries for similar man pages. configure.ac: include new file in AC_CONFIG_FILES([...]) doc/man/Makefile.am: include new file in MAN_PAGES doc/man/.gitignore: ignore derived file freeciv.6 See osdn #42138. Signed-off-by: Jim DeLaHunt --- configure.ac | 1 + doc/man/.gitignore | 1 + doc/man/Makefile.am | 1 + doc/man/freeciv.6.in | 123 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 126 insertions(+) create mode 100644 doc/man/freeciv.6.in diff --git a/configure.ac b/configure.ac index f389257497..4d531a5330 100644 --- a/configure.ac +++ b/configure.ac @@ -1796,6 +1796,7 @@ AC_CONFIG_FILES([Makefile translations/ruledit/Makefile.in doc/Makefile doc/man/Makefile + doc/man/freeciv.6 doc/man/freeciv-client.6 doc/man/freeciv-server.6 doc/man/freeciv-manual.6 diff --git a/doc/man/.gitignore b/doc/man/.gitignore index a5a4a1f864..666400692b 100644 --- a/doc/man/.gitignore +++ b/doc/man/.gitignore @@ -1,6 +1,7 @@ /Makefile /Makefile.in /.deps +/freeciv.6 /freeciv-server.6 /freeciv-client.6 /freeciv-modpack.6 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 7cf3779aec..12f569f9db 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,6 +1,7 @@ ## Process this file with automake to produce Makefile.in MAN_PAGES = \ + freeciv.6 \ freeciv-server.6 \ freeciv-client.6 \ freeciv-modpack.6 \ diff --git a/doc/man/freeciv.6.in b/doc/man/freeciv.6.in new file mode 100644 index 0000000000..6ed782c555 --- /dev/null +++ b/doc/man/freeciv.6.in @@ -0,0 +1,123 @@ +.\" 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. +.\" +.TH FREECIV 6 "May 11th 2021" +.SH NAME +freeciv \- The Freeciv game (overview) +.SH SYNOPSIS +.B freeciv-gtk3.22|freeciv-sdl2|freeciv-qt|\ +freeciv-\fI[various...]\fP [ options... ] +.br +.B freeciv-server [ options... ] +.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: +To become the greatest civilization. +.PP +Players of Civilization II\*R by Microprose\*R should feel at home, since one +aim of Freeciv is to have compatible rules. +.PP +Freeciv is maintained by an international team of coders and enthusiasts, +and is easily one of the most fun and addictive network games out there! +.PP +Freeciv is designed to be played either over a network or on one machine. +There can be a single human player, or multiple human player in different +locations on different kinds of computers. +Freeciv can operate artificial intelligence (AI) players as desired, +to fill out the game. +.PP +Human players run a +.IR freeciv-client (6) +program to join a game. There are several different Freeciv client programs +to choose between. The Freeciv client can be thought of as a thin window +onto the server's information and activity. +.PP +The terrain, rules, and activity of the game are held by a running +.IR freeciv-server (6) +program. In a single-player game, the player's client program starts up its +own local server program behind the scenes. In a multi-player game, someone +starts the server first, then players connect to that server. The server runs +the AI players. +The server enforces the game rules, even if a cleverly-modified client +program tries to cheat. +.PP +The Freeciv game is translated into many different languages. +Generally, the Freeciv client follows the conventions of the computer it +runs on to determine which language it should use when presenting the game +to the player. +.PP +The Freeciv game offers many ways to tweak how games are set up, +and to create completely different looks and game play. +When starting the Freeciv server, you can adjust many parameters of the game +map, rules, and models which drive the game. +You can set the the number and difficulty level of the AI players. +You can set the size of the map and the kind of terrain. +You can also choose among various rule sets and scenarios, which can lead to +very different kinds of games. +When running a Freeciv client, you can choose among tilesets and soundsets, +to adjust how games look and sound. +.PP +The Freeciv community offers even more scenarios, rulesets, +tilesets, and soundsets. +A +.IR freeciv-modpack (6) +utility lets you locate and download this additional content. +.PP +There are Freeciv "metaservers" which catalogue Freeciv servers seeking +to attract players. One is operated by the Freeciv project. When starting a +Freeciv client, you may have it contact a metaserver to find games to join. +When starting a Freeciv server, you may have it publish its presence with a +metaserver. +.SH BUGS +Please report bugs to the Freeciv bug tracker, @BUG_URL@ . +.SH "MORE INFO" +There is a great deal more information at the Freeciv homepage, @WIKI_URL@ . +Updates and new info are first posted there. +A Client Manual, a Server Manual, and a wiki on many topics, +are published there. +There is a user forum linked to from there. +.PP +Freeciv installers include a number of documentation files with the game. +See the \fIFILES\fP section for the location. +They make interesting reading \(em especially after you have played for +a while, when you are beginning to wonder how you can do more, and why the +AI players can do so much. +.SH FILES +.TP +.B bin/freeciv-\fI*\fP, bin/freeciv-server, bin/freeciv-mp-\fI*\fP +These are the executable programs. There are several client programs, a +server program, several modpack programs, and some other Freeciv +developer utilities. +.TP +.B share/doc/freeciv/README.\fI*\fP +These are documentation files describing how the game and some of the +included rulesets operate, in detail. +.SH AUTHORS +The Freeciv Team <@MAIL_ADDRESS@>. +.PP +This manpage was originally drafted by Jim DeLaHunt . +It was based on the freeciv-client and freeciv-server pages by Florian Ernst + and Ben Bettin . +Feel free to use it as you wish. +.SH "SEE ALSO" +.IR freeciv-client (6) +.IR freeciv-server (6) +.IR freeciv-modpack (6) +.IR freeciv-ruledit (6) +.IR freeciv-ruleup (6) +.IR freeciv-manual (6) +.IR freeciv-gtk3.22 (6) +.IR freeciv-qt (6) +.IR freeciv-sdl2 (6) +.IR freeciv-mp-cli (6) +.IR freeciv-mp-gtk3 (6) +.IR freeciv-mp-qt (6) +and the Client Manual and the Server Manual on the Freeciv website. -- 2.31.1