From 2d2581afba68d179cd9bc335e3015c0af063d023 Mon Sep 17 00:00:00 2001 From: Mikael Djurfeldt <mikael@djurfeldt.com> Date: Wed, 4 Dec 2019 02:18:44 +0100 Subject: [PATCH] Provide missing manpages --- doc/Makefile.am | 3 ++- doc/music_tests.1 | 44 ++++++++++++++++++++++++++++++++++++++++++++ doc/musicrun.1 | 41 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 doc/music_tests.1 create mode 100644 doc/musicrun.1 diff --git a/doc/Makefile.am b/doc/Makefile.am index 242af45..60a281a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,6 +1,7 @@ ## Process this file with Automake to create Makefile.in -dist_man1_MANS = music.1 contsink.1 eventcounter.1 eventgenerator.1 eventlogger.1 \ +dist_man1_MANS = music.1 musicrun.1 music_tests.1 contsink.1 eventcounter.1 \ + eventgenerator.1 eventlogger.1 \ eventselect.1 eventsink.1 eventsource.1 messagesource.1 viewevents.1 EXTRA_DIST = music-manual.pdf figures/dataconvergence.asy figures/datamapping.asy \ diff --git a/doc/music_tests.1 b/doc/music_tests.1 new file mode 100644 index 0000000..993b6c4 --- /dev/null +++ b/doc/music_tests.1 @@ -0,0 +1,44 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH MUSIC 1 "March 5, 2009" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +music_tests \- run MUSIC tests +.SH SYNOPSIS +.B music_tests +.RI [ options ] +.SH DESCRIPTION +Run a suite of tests validating the correct operation of MUSIC. +.SH OPTIONS +.B \-\-help +Show program options and exit. +.TP +.B \-\-showme\-tests +Print test names and exit. +.TP +.B \-\-output\-dir=<PATH> +Output directory (default: ./reports). +.SH SEE ALSO +.BR music (1). +.\" .br +.\" The programs are documented fully by +.\" .IR "The Rise and Fall of a Fooish Bar" , +.\" available via the Info system. +.SH AUTHOR +music_tests was written by Ekaterina Brocke.. +.PP +This manual page was written by Mikael Djurfeldt <mdj@debian.org>, +for the Debian project (but may be used by others). diff --git a/doc/musicrun.1 b/doc/musicrun.1 new file mode 100644 index 0000000..4cd9e27 --- /dev/null +++ b/doc/musicrun.1 @@ -0,0 +1,41 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH MUSIC 1 "March 5, 2009" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +musicrun \- launch a MUSIC co-simulation +.SH SYNOPSIS +.B music_tests +.I number_of_tasks +.I configuration_file +.SH DESCRIPTION +Launch a MUSIC co-simulation. +.PP +This is a convenience utility which provides a similar interface over +multiple MPI implementations. +.SH SEE ALSO +.BR music (1). +.\" .BR bar (1), +.\" .BR baz (1). +.\" .br +.\" The programs are documented fully by +.\" .IR "The Rise and Fall of a Fooish Bar" , +.\" available via the Info system. +.SH AUTHOR +musicrun was written by Ekaterina Brocke.. +.PP +This manual page was written by Mikael Djurfeldt <mdj@debian.org>, +for the Debian project (but may be used by others). -- GitLab