From a2d4c25bb23e9ede744b88669737c7e6e2194753 Mon Sep 17 00:00:00 2001 From: Lorenzo Figini Date: Wed, 22 Dec 2021 19:42:02 +0100 Subject: [PATCH] Change documentation formatting Revert temporarily to default fonts to improve portability. Add section header markers to the man page. --- doc/1.intro.md | 6 +++--- doc/gray.1 | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/1.intro.md b/doc/1.intro.md index 6ec45c0..053c852 100644 --- a/doc/1.intro.md +++ b/doc/1.intro.md @@ -106,9 +106,9 @@ references: issued: 2003-3-5, 2003-4-5 # Font -mainfont: Libertinus Serif -mathfont: Libertinus Math -monofont: Fira Mono +# mainfont: Libertinus Serif +# mathfont: Libertinus Math +# monofont: Fira Mono # PDF output options classoptions: diff --git a/doc/gray.1 b/doc/gray.1 index b02a970..c93b131 100644 --- a/doc/gray.1 +++ b/doc/gray.1 @@ -1,4 +1,4 @@ -[INPUT FILES] +.SH [INPUT FILES] All files used by \fBgray\fR are only named by convention since their filenames must be manually specified, except the parameters file. The latter defaults to \fCgray_params.data\fR and is configured using the @@ -29,12 +29,12 @@ Plasma kinetic profiles file This file contains the radial profiles of the plasma temperature, density and effective charge. -[OUTPUT FILES] +.SH [OUTPUT FILES] GRAY output files are named according to the Fortran unit number (e.g \fCfort.4\fR) and written to the current directory, by default. The location can be changed with the \fB-o\fR option. For a list of the unit numbers and their descriptions see the GRAY user manual. -[SEE ALSO] +.SH [SEE ALSO] \fBgray_params.data\fR(5), \fBbeamdata.txt\fR(5), \fBprofiles.txt\fR(5)