commit 452623bb5f346676f576eb966ac9c5a1bf5626ea
parent 21f478e375c05b57d50d19df8e78ebd7150fc86e
Author: Friedel Schön <[email protected]>
Date: Thu, 1 Jun 2023 13:03:45 +0200
adding doc-contrib
Diffstat:
4 files changed, 69 insertions(+), 24 deletions(-)
diff --git a/contrib/command.txt b/contrib/command.txt
@@ -0,0 +1,22 @@
+FISS COMMANDS
+=============
+
+ + new in fiss, - same as in runit, ~ different behaviour
+
+- up (u): starts the services, pin as started
+- down (d): stops the service, pin as stopped
+- once (o): starts the service, pin as started once
++ xup (U): stops the service, don't pin as stopped
++ xdown (D): stops the service, don't pin as stopped
+- term (t): same as down
+- kill (k): sends kill, pin as stopped
+- pause (p): pauses the service
+- cont (c): resumes the service
++ reset (r): resets the service (fail-count)
+- alarm (a): sends alarm
+- hup (h): sends hup
+- int (i): sends interrupt
+- quit (q): sends quit
+- usr1 (1): sends usr1
+- usr2 (2): sends usr2
+~ exit (x): does nothing (actually exits the runsv instance)
+\ No newline at end of file
diff --git a/contrib/docs.txt b/contrib/docs.txt
@@ -0,0 +1,45 @@
+The Documentation markup (in src/docs, src/man) isn't just Markdown or whatever but
+an own language which is intended to be parsed really easy, don't expect a lot, it's just
+some ' '-splitting and regex-replacing.
+In this document I want to present the syntax.
+
+Conversion is done with the scripts make-docs.py for html and make-man.py for obviously man
+
+Blocks and Titles
+=================
+
+@header <text...>
+
+Prints the header with <text> as header-text, followed by 'shut the lights off'-button and github-link.
+It's ignored if converted to man.
+
+@man <manual> <section> <date> <version> <manual-title>
+
+Prints the manual-header.
+It's ignored if converted to html.
+
+@title <id> <text...>
+
+Prints a (section) title, <id> is used for click-to-section.
+<id> is ignored by man.
+
+@list
+...
+@endlist
+
+Make a list delimited by empty lines.
+
+@code
+...
+@endcode
+
+Make an code-block, ignored by man.
+
+
+Inline Markup
+=============
+
+*bold*
+_italic_
+[text](http://link.com) | ignored by man
+text~ | prints a newline, without interpreting something else
+\ No newline at end of file
diff --git a/internal/serialize.txt b/contrib/serialize.txt
diff --git a/internal/command.txt b/internal/command.txt
@@ -1,23 +0,0 @@
-FISS COMMANDS
-=============
-
- + new in fiss, - same as in runit, ! different behaviour
-
-- up (u): starts the services, pin as started
-- down (d): stops the service, pin as stopped
-- once (o): starts the service, pin as started once
-+ xup (U): stops the service, don't pin as stopped
-+ xdown (D): stops the service, don't pin as stopped
-- term (t): same as down
-- kill (k): sends kill, pin as stopped
-- pause (p): pauses the service
-- cont (c): resumes the service
-+ reset (r): resets the service (fail-count)
-+ send (s): sends custom signal, followed by signal-byte
-- alarm (a): sends alarm
-- hup (h): sends hup
-- int (i): sends interrupt
-- quit (q): sends quit
-- usr1 (1): sends usr1
-- usr2 (2): sends usr2
-! exit (x): does nothing (actually exits the runsv instance)
-\ No newline at end of file
