From 653276216fbdefec4803e413e2439d808ed5ae0b Mon Sep 17 00:00:00 2001 From: Peter Teuben Date: Sun, 20 Oct 2024 21:54:17 -0400 Subject: [PATCH] format --- man/man1/quadcode.1 | 39 +++++++++++++++++++++++++-------------- man/man1/quadforce.1 | 34 +++++++++++++++++++++------------- man/man1/quadinter.1 | 31 +++++++++++++++++++------------ 3 files changed, 65 insertions(+), 39 deletions(-) diff --git a/man/man1/quadcode.1 b/man/man1/quadcode.1 index c4cbb9669..0b1f3bef9 100644 --- a/man/man1/quadcode.1 +++ b/man/man1/quadcode.1 @@ -1,9 +1,12 @@ -.TH QUADCODE 1NEMO "6 May 1992" -.SH NAME +.TH QUADCODE 1NEMO "20 Oct 2024" + +.SH "NAME" quadcode \- global quadrupole-order N-body code integrator -.SH SYNOPSIS + +.SH "SYNOPSIS" \fBquadcode\fP \fBin=\fP\fIsnapshot\fP [\fIparameter\fP=\fIvalue\fP] .\|.\|. -.SH DESCRIPTION + +.SH "DESCRIPTION" \fIquadcode\fP is an equal-timestep implementation of an N-body code where the forces and potential are computed from a potential expansion in spherical harmonics @@ -12,8 +15,9 @@ it multipole expansion). See also a followup in Bontekoe & van Albada (MNRAS 224, 349 (1987)) and a rebuttal in Zaritsky & White (MNRAS 235, 289 (1988). See also Hernquist, L. & Barnes, J. \fIAp.J.\fP \fB349\fP, 562 (1990) -.SH PARAMETERS -The following parameters are recognized; they may be given in any order. + +.SH "PARAMETERS" +.so man1/parameters .TP 24 \fBin\fP=\fIin-file\fP Snapshot with initial conditions. No default. @@ -82,25 +86,32 @@ to be recompiled, for example: (Note that all \fIquad*\fP programs need to (should) be recompiled if the maximum allowed number of bodies will be changed. -.SH SEE ALSO -quadforce(1NEMO), quadinter(1NEMO), CSG(1NEMO), octcode(1NEMO) -.SH ADS + +.SH "SEE ALSO" +quadforce(1NEMO), quadinter(1NEMO), CSG(1NEMO), octcode(1NEMO) + +.SH "ADS" @ads 1983ApJ...274...53W closely derived code? or should we link White's 1978MNRAS.184..185W paper -.SH BUGS + +.SH "BUGS" When a \fBrestart\fP is specified, values must be given for \fBALL\fP legal parameters which do not take default values. -.SH AUTHOR + +.SH "AUTHOR" Joshua E. Barnes. -.SH FILES + +.SH "FILES" .nf .ta +2i src/nbody/evolve/multicode/ exported source code usr/josh/nbody/multicode/ Josh' original source code .fi -.SH HISTORY + +.SH "HISTORY" .nf -.ta +1i +4i +.ta +1.25i +4.5i 4-mar-89 V1.2 some formal NEMO version JEB 12-nov-91 V1.3 new NEMO V2. location in $NEMO/src tree PJT 6-may-92 document improved PJT +20-oct-2024 V1.4a gcc-14 prototype fixed PJT .fi diff --git a/man/man1/quadforce.1 b/man/man1/quadforce.1 index 425c2984b..2f87ae3e6 100644 --- a/man/man1/quadforce.1 +++ b/man/man1/quadforce.1 @@ -1,17 +1,20 @@ -.TH QUADFORCE 1NEMO "6 May 1992" -.SH NAME +.TH QUADFORCE 1NEMO "20 Oct 2024" + +.SH "NAME" quadforce \- quadrupole-order force calculation of an N-body system. -.SH SYNOPSIS + +.SH "SYNOPSIS" \fBquadforce\fP \fBin=\fPsnapshot [parameter=value] ... -.SH DESCRIPTION + +.SH "DESCRIPTION" \fIquadforce\fP computes a quadrupole-order force calculation of a snapshot N-body system. (see also \fIquadcode(1NEMO)\fP). The output can be either in the form of the snapshot, or a table, in which case quadrupole-oder forces can be inserted in other snapshots (see \fIquadinter(1NEMO)\fP). -.SH PARAMETERS -The following parameters are recognized in any order if the keyword -is also given: + +.SH "PARAMETERS" +.so man1/parameters .TP 20 \fBin=\fP\fIsnaphot\fP Input file with N-body snapshot. No default. @@ -28,18 +31,23 @@ Radial softening parameter. [Default: \fB0.05\fP] .TP 20 \fBeps_t=\fP Tangential softening parameter. [Default: \fB0.07\fP] -.SH LIMITATIONS + +.SH "LIMITATIONS" The code has a hardcoded maximum number of particles, through the macro \fBMBODY\fP. (currently 4096). If more are needed, it needs to be recompiled. See comments in \fIquadcode(1NEMO)\fP -.SH AUTHOR -Joshue Barnes -.SH SEE ALSO + +.SH "AUTHOR" +Joshua Barnes + +.SH "SEE ALSO" quadcode(1NEMO), quadinter(1NEMO) -.SH UPDATE HISTORY + +.SH "HISTORY" .nf -.ta +1.0i +4.0i +.ta +1.25i +4.5i 4-mar-89 V1.0 Old version JEB 12-nov-91 V1.1 FOr new nemo V2. PJT 6-may-92 V1.1a man page written, added some warnings PJT +20-oct-2024 V1.4a fix various prototypes for modern gcc PJT .fi diff --git a/man/man1/quadinter.1 b/man/man1/quadinter.1 index 67a9158d2..9d8027239 100644 --- a/man/man1/quadinter.1 +++ b/man/man1/quadinter.1 @@ -1,15 +1,18 @@ -.TH QUADINTER 1NEMO "6 May 1992" -.SH NAME +.TH QUADINTER 1NEMO "20 Oct 2024" + +.SH "NAME" quadinter \- quadrupole-order force calculation from tabulated field. -.SH SYNOPSIS + +.SH "SYNOPSIS" \fBquadinter\fP \fBquad=\fIquad_table\fP \fBin=\fIsnapshot\fP [parameter=value] ... -.SH DESCRIPTION + +.SH "DESCRIPTION" \fIquadinter\fP computes quadrupole-order forces and potentials for a set of particules supplies in an N-body snapshot from a quad-table that must have been prepared by \fIquadforce\fP. -.SH PARAMETERS -The following parameters are recognized in any order if the keyword -is also given: + +.SH "PARAMETERS" +.so man1/parameters .TP 20 \fBquad=\fP\fIquad_table\fP Input file with quadrupole-order field tables. No default. @@ -20,18 +23,22 @@ Input file with an N-body snapshot. No default. \fBout=\fP output file with added forces and potentials. This will be a copy of the input \fIsnapshot\fP. Default: none. -.SH LIMITATIONS + +.SH "LIMITATIONS" The code has a hardcoded maximum number of particles, through the macro \fBMBODY\fP. (currently 4096). If more are needed, it needs to be recompiled. See comments in \fIquadcode(1NEMO)\fP -.SH SEE ALSO + +.SH "SEE ALSO" quadcode(1NEMO), quadforce(1NEMO) -.SH AUTHOR + +.SH "AUTHOR" Joshua Barnes -.SH UPDATE HISTORY +.SH "HISTORY" .nf -.ta +1.0i +4.0i +.ta +1.25i +4.5i 4-mar-89 V1.0 Old version JEB 12-nov-91 V1.1 For new nemo V2. PJT 6-may-92 V1.1a man page written PJT +20-oct-2024 V1.4a gcc-14 prototype fixes PJT .fi