diff options
author | Y. Wang <yw05@forksworld.de> | 2022-08-10 11:16:05 +0200 |
---|---|---|
committer | Y. Wang <yw05@forksworld.de> | 2022-08-10 11:16:05 +0200 |
commit | 80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d (patch) | |
tree | 1baaae42bfd67c3c6b1084acbcaa1a9cfa1773dc /assets/manual/man/man7advtrains | |
parent | 764f7d42913698d9c46f6b1adcff4f0fd73a86b0 (diff) | |
download | advtrains-80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d.tar.gz advtrains-80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d.tar.bz2 advtrains-80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d.zip |
Reformat advtrains.speed docs as manual pages; minor formatting changes
Diffstat (limited to 'assets/manual/man/man7advtrains')
-rw-r--r-- | assets/manual/man/man7advtrains/speed.7advtrains.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/assets/manual/man/man7advtrains/speed.7advtrains.md b/assets/manual/man/man7advtrains/speed.7advtrains.md new file mode 100644 index 0000000..bf8ed08 --- /dev/null +++ b/assets/manual/man/man7advtrains/speed.7advtrains.md @@ -0,0 +1,18 @@ +% SPEED(7ADVTRAINS) | Advtrains Developer's Manual + +# NAME +`speed` - Advtrains speed limit library + +# DESCRIPTION +The speed library allows the manipulation of speed limits, which can be represented with + +* A non-negative number, which stands for a regular speed limit in m/s, or +* -1 or `nil`, which lifts the speed restriction + +The use of other values (in particular, nan and infinity) may result in undefined behavior. + +This library is available as `advtrains.speed`. + +# NOTES + +The meaning of `nil` for the speed limit library differs from its meaning in signal aspect tables, where `nil` keeps the current speed limit. |