istp/gray
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Change documentation formatting

Browse Source 
Revert temporarily to default fonts to improve portability.
Add section header markers to the man page.
This commit is contained in:
Lorenzo Figini 2021-12-22 19:42:02 +01:00 committed by Michele Guerini Rocco
parent 9a6063389e
commit a2d4c25bb2
Signed by: rnhmjoj
GPG Key ID: BFBAF4C975F76450
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/1.intro.md
View File

@ -106,9 +106,9 @@ references:
issued: 2003-3-5, 2003-4-5 issued: 2003-3-5, 2003-4-5
# Font # Font
mainfont: Libertinus Serif # mainfont: Libertinus Serif
mathfont: Libertinus Math # mathfont: Libertinus Math
monofont: Fira Mono # monofont: Fira Mono
# PDF output options # PDF output options
classoptions: classoptions:

6
doc/gray.1
View File

@ -1,4 +1,4 @@
[INPUT FILES] .SH [INPUT FILES]
All files used by \fBgray\fR are only named by convention since their filenames All files used by \fBgray\fR are only named by convention since their filenames
must be manually specified, except the parameters file. must be manually specified, except the parameters file.
The latter defaults to \fCgray_params.data\fR and is configured using the 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 This file contains the radial profiles of the plasma temperature, density and
effective charge. effective charge.
[OUTPUT FILES] .SH [OUTPUT FILES]
GRAY output files are named according to the Fortran unit number (e.g 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 \fCfort.4\fR) and written to the current directory, by default. The
location can be changed with the \fB-o\fR option. 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. 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) \fBgray_params.data\fR(5), \fBbeamdata.txt\fR(5), \fBprofiles.txt\fR(5)