fen.1: add initial man page - chess-puzzles - chess puzzle book generator
(HTM) git clone git://git.codemadness.org/chess-puzzles
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 528629a967639e013c56fee9c293b7b87376d15e
(DIR) parent 212c82b75fc13feab19a991ac284ab92e3c352ff
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Thu, 21 Dec 2023 00:20:34 +0100
fen.1: add initial man page
Diffstat:
A fen.1 | 52 +++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+), 0 deletions(-)
---
(DIR) diff --git a/fen.1 b/fen.1
@@ -0,0 +1,52 @@
+.Dd December 20, 2023
+.Dt FEN 1
+.Os
+.Sh NAME
+.Nm fen
+.Nd parse FEN and moves and write output
+.Sh SYNOPSIS
+.Nm
+.Op Fl cCfF
+.Op Fl o Ar ascii | fen | svg | tty
+.Op Ar FEN
+.Op Ar moves
+.Sh DESCRIPTION
+.Nm
+parses the Forsyth-Edwards Notation (FEN) and moves and write the output to a
+chosen format.OA
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl c
+Enable board coordinates, default is on.
+.It Fl C
+Disable board coordinates.
+.It Fl f
+Flip the board, default is off.
+.It Fl F
+Do not flip the board.
+.It Fl o Ar format
+Output format to one of the following format:
+.Bl -tag -width Ds
+.It ascii
+ASCII text representation of the board.
+FEN of the board state after playing the moves.
+.It fen
+FEN of the board state after playing the moves.
+.It svg
+SVG image of the board.
+.It tty
+Text representation of the board suitable for a terminal.
+The terminal requires UTF-8 support for chess symbols and it uses truecolor for
+the board theme.
+.El
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh EXAMPLES
+.Bd -literal
+fen -o tty startpos e2e4
+
+fen startpos e2e4 > board.svg
+.Ed
+.Sh AUTHORS
+.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org