Skip to content

Commit

Permalink
Update generated HELICS apps manpages (#1125)
Browse files Browse the repository at this point in the history
* Generate updated HELICS manpages

* Update CHANGELOG.md
  • Loading branch information
nightlark authored Mar 7, 2020
1 parent 3687fe9 commit 236a9fe
Show file tree
Hide file tree
Showing 12 changed files with 49 additions and 22 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Increased code coverage and additional bug fixes. The error propagation in HELI
- the `error` Function in the C++ API is now the same as `localError` previously it was primary useful for logging and didn't do much, and will be deprecated in the next release.
- Updated the GitHub actions (clang-format, swig interface updates, and release builds) to use actions/checkout@v2
- Cleaned up the Windows installer (better component names/descriptions and groups, link to Gitter, and require installing Headers to install SWIG)
- Updated the HELICS apps manpages with new options

### Fixed
- Issue with iterative requests that were not being honored if the federate was acting in isolation
Expand Down
17 changes: 15 additions & 2 deletions docs/man/manpage_out/helics_app-broker.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-broker
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-BROKER" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-BROKER" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -202,6 +202,11 @@ Specify a key to use to verify all connections to/from a broker\&.
Specify that a broker might be slow or unresponsive to ping requests from other brokers\&.
.RE
.PP
\-\-terminate_on_error
.RS 4
Specify that a broker should treat all errors as global errors and terminate the co\-simulation if an error is encountered
.RE
.PP
\-\-restrictive_time_policy, \-\-conservative_time_policy
.RS 4
Specify that a broker should use a conservative time policy in the time coordinator\&.
Expand Down Expand Up @@ -263,6 +268,14 @@ Time to wait for a broker connection\&. Can be entered as a time like
or
\fI45ms\fR\&. Default unit is ms\&.
.RE
.PP
\-\-errortimeout <time(ms)>
.RS 4
Time to wait after an error has occured before disconnecting\&. Can be entered as a time like
\fI10s\fR
or
\fI45ms\fR\&. Default unit is ms\&.
.RE
.SH "SEE ALSO"
.sp
helics_broker(1)
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app-clone.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-clone
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-CLONE" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-CLONE" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app-echo.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-echo
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-ECHO" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-ECHO" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app-player.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-player
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-PLAYER" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-PLAYER" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app-recorder.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-recorder
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-RECORDER" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-RECORDER" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app-source.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-source
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-SOURCE" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-SOURCE" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app-tracer.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app-tracer
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP\-TRACER" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP\-TRACER" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_app.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_app
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_APP" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_APP" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_broker-term.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_broker-term
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_BROKER\-TERM" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_BROKER\-TERM" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
17 changes: 15 additions & 2 deletions docs/man/manpage_out/helics_broker.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_broker
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_BROKER" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_BROKER" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -208,6 +208,11 @@ Specify a key to use to verify all connections to/from a broker\&.
Specify that a broker might be slow or unresponsive to ping requests from other brokers\&.
.RE
.PP
\-\-terminate_on_error
.RS 4
Specify that a broker should treat all errors as global errors and terminate the co\-simulation if an error is encountered
.RE
.PP
\-\-restrictive_time_policy, \-\-conservative_time_policy
.RS 4
Specify that a broker should use a conservative time policy in the time coordinator\&.
Expand Down Expand Up @@ -269,6 +274,14 @@ Time to wait for a broker connection\&. Can be entered as a time like
or
\fI45ms\fR\&. Default unit is ms\&.
.RE
.PP
\-\-errortimeout <time(ms)>
.RS 4
Time to wait after an error has occured before disconnecting\&. Can be entered as a time like
\fI10s\fR
or
\fI45ms\fR\&. Default unit is ms\&.
.RE
.SH "SUBCOMMANDS"
.PP
helics_broker\-term(1)
Expand Down
4 changes: 2 additions & 2 deletions docs/man/manpage_out/helics_player.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: helics_player
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 01/24/2020
.\" Date: 03/06/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HELICS_PLAYER" "1" "01/24/2020" "\ \&" "\ \&"
.TH "HELICS_PLAYER" "1" "03/06/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down

0 comments on commit 236a9fe

Please sign in to comment.