aboutsummaryrefslogtreecommitdiff
path: root/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md
diff options
context:
space:
mode:
authorY. Wang <yw05@forksworld.de>2022-08-10 15:12:13 +0200
committerY. Wang <yw05@forksworld.de>2022-08-10 15:12:13 +0200
commit69d8388c672d695f2031ebc13ac4a83ab220b93f (patch)
tree43740f1cdda65ca2272d61154d0ff0efb41692b5 /assets/manual/man/man7advtrains/signal_aspects.7advtrains.md
parent48b9922071c6e338a3ab6ebdea01fc57940cd7f8 (diff)
downloadadvtrains-69d8388c672d695f2031ebc13ac4a83ab220b93f.tar.gz
advtrains-69d8388c672d695f2031ebc13ac4a83ab220b93f.tar.bz2
advtrains-69d8388c672d695f2031ebc13ac4a83ab220b93f.zip
Reformat the rest of the developer's manual as manpages
Diffstat (limited to 'assets/manual/man/man7advtrains/signal_aspects.7advtrains.md')
-rw-r--r--assets/manual/man/man7advtrains/signal_aspects.7advtrains.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md b/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md
new file mode 100644
index 0000000..0066f7f
--- /dev/null
+++ b/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md
@@ -0,0 +1,25 @@
+---
+title: 'SIGNAL_ASPECTS(7ADVTRAINS) | Advtrains Developer''s Manual'
+seealso:
+- speed(7advtrains)
+---
+
+# NAME
+`signal_aspects` - Signal aspect tables for Advtrains
+
+# DESCRIPTION
+A signal aspect table describes the status of a signal in relation to a train following it.
+
+A signal aspect table may contain the following fields:
+
+* `main`: The main aspect of the signal
+* `type`: The type of speed restriction imposed by the main aspect
+* `dst`: The distant aspect of the signal
+* `shunt`: A boolean indicating whether shunting is allowed
+* `proceed_as_main`: A boolean indicating whether a train in shunt mode should continue with shunt mode disabled
+
+The `main` and `dst` fields may contain
+
+* A non-negative number indicating the current or next speed limit
+* -1, indicating that the speed limit is or will be lifted
+* `nil`, indicating that the speed limit is or will not be changed