 |
improve man page documentation - chess-puzzles - chess puzzle book generator |
 |
git clone git://git.codemadness.org/chess-puzzles |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
commit 4d582297eea29262d3ed81b786c28276e006589f |
|
parent 667fa14261d797a2c04938992a4efa5061e558a2 |
|
Author: Hiltjo Posthuma <[email protected]> |
|
Date: Thu, 21 Dec 2023 18:15:09 +0100 |
|
|
|
improve man page documentation |
|
|
|
Diffstat: |
|
M README | 9 ++------- |
|
M fen.1 | 6 +++++- |
|
|
|
2 files changed, 7 insertions(+), 8 deletions(-) |
|
--- |
|
diff --git a/README b/README |
|
@@ -24,13 +24,8 @@ Files |
|
Read puzzles, shuffle them. Do some sorting based on difficulty and |
|
assign score points. |
|
* fen.c: |
|
- Read and parse FEN and a few moves and output to various formats: |
|
- - ascii: ASCII text representation of the board. |
|
- - fen: FEN of the board state after playing the moves. |
|
- - svg: SVG image of the board. |
|
- - tty: Text representation of the board suitable for a terminal. The |
|
- terminal requires UTF-8 support for chess symbols and it uses |
|
- true-color for the board color theme. |
|
+ Read and parse FEN and a few moves and output to various formats. |
|
+ See the man page for detailed usage information. |
|
|
|
|
|
References |
|
diff --git a/fen.1 b/fen.1 |
|
@@ -1,4 +1,4 @@ |
|
-.Dd December 20, 2023 |
|
+.Dd December 21, 2023 |
|
.Dt FEN 1 |
|
.Os |
|
.Sh NAME |
|
@@ -50,3 +50,7 @@ fen startpos e2e4 > board.svg |
|
.Ed |
|
.Sh AUTHORS |
|
.An Hiltjo Posthuma Aq Mt [email protected] |
|
+.Sh CAVEATS |
|
+.Nm |
|
+supports classical chess and chess960 only. |
|
+Input moves are not validated, they are assumed to be legal. |
