Fix PR19502 by adding the "GETTING HELP" section to the stap.1 manpage.

Move stap.1 to stap.1.in so that it can contain autoconf macros.  Add
the "GETTING HELP" section to it.  Do the same with the czech version
of the manpage.

diff --git a/configure.ac b/configure.ac
index 160c07dbaeaf73a55d16dcfd6af688d77d372970..70058daa913a3ead3031a9d8194ebd031fd54b5c 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -711,7 +711,8 @@ AC_SUBST(STAP_PREFIX, "$stap_prefix")
 AC_CONFIG_HEADERS([config.h:config.in])
 AC_CONFIG_FILES([Makefile doc/Makefile man/Makefile man/cs/Makefile \
 doc/beginners/Makefile doc/SystemTap_Tapset_Reference/Makefile \
-man/stappaths.7 man/systemtap.8 \
+man/stap.1 man/stappaths.7 man/systemtap.8 \
+man/cs/stap.1 \
 initscript/config.systemtap initscript/config.stap-server \
 initscript/systemtap initscript/stap-server \
 initscript/99stap/module-setup.sh ])

diff --git a/man/cs/stap.1 b/man/cs/stap.1.in
similarity index 97%
rename from man/cs/stap.1
rename to man/cs/stap.1.in
index 5b049b0013ec7ab9cfa7452f65c653178bf7316e..0a159503d2183e006337ef2c1475a20e3185c5c0 100644 (file)
--- a/man/cs/stap.1
+++ b/man/cs/stap.1.in
@@ -87,6 +87,68 @@ stap \- překladač a řadič systemtap skriptů
 ]
 .B \-\-dump-functions
 
+.SH "ZDROJE INFORMACÍ"
+
+Pro SystemTap existuje pestrá škála dokumentace. Je dostupná jak online na
+adrese https://sourceware.org/systemtap/, tak (z větší části) i v rámci
+distribučních balíčků.
+
+Pro začátečníky je ideální
+.IR "Beginner's Guide".
+Přináší čtivý úvod do základních principů funkce
+nástroje jako celku, jeho skriptovacího jazyka, a také řadu příkladů.
+.IR "Systemtap Tutorial"
+pak jde více do hloubky a obsahuje cvičení.
+.IR "Language Reference"
+Podrobně popisuje syntaxi skriptovacího jazyka systemtapu.  Ta je v základních
+rysech podobná syntaxi jazyků C a awk, ale obsahuje i netradiční prvky, jako
+například statistické nástroje.
+.IR "Tapset Reference"
+přináší přehled rozšiřitelné knihovny tapsetů.  Taktéž je k dispozici rozsáhlá 
+.IR "sbírka příkladů".
+Jsou dostupné jak online setříděné do kategorií na projektovém webu,
+tak i offline v rámci distribučních balíčků, viz
+@prefix@/share/doc/systemtap*/examples. Často jde o přímo použitelné nástroje
+pro analýzu a správu systému.
+
+Seznam manuálových stránek:
+
+.TP
+.BI stapprobes(3stap)
+Přehled sondážních bodů a přezdívek a související syntaxe.
+.TP
+.BI "function::*(3stap), probe::*(3stap), tapset::*(3stap)"
+Individuální manuálové stránky pro jednotlivé funkce, sondážní body a tapsety.
+Kompletní seznam nalezne čtenář v adresáři
+@prefix@/share/man/man3/.
+.TP
+.BI stappaths(7)
+Přehled důležitých umístění v rámci adresářové struktury.
+.TP
+.BI staprun(8)
+Řadič pro jaderné moduly systemtapu.
+.TP
+.BI stapdyn(8)
+Nástroj Dyninst pro dynamickou instrumentaci.
+.TP
+.BI systemtap(8)
+Služba umožňující spustit systemtap skript jako démon.
+.TP
+.BI stapvars(3stap)
+Veřejné proměnné definované knihovnou tapsetů.
+.TP
+.BI stapex(3stap)
+Několik jednoduchých příkladů systemtap syntaxe.
+.TP
+.BI stap-server(8)
+Kompilační server Systemtapu.
+.TP
+.BI stap-prep(1)
+Instalátor závislostí, jako např. ladicích informací jádra.
+.TP
+.BI stapref(1)
+Rychlá reference pro skriptovací jazyk systemtapu.
+
 .SH POPIS
 
 Program

diff --git a/man/stap.1 b/man/stap.1.in
similarity index 97%
rename from man/stap.1
rename to man/stap.1.in
index 440cbac7ad2010e48c6b7752841be3b673ea20a7..ae58380aa2b3913b7596bc66a52de026fb7f2eb3 100644 (file)
--- a/man/stap.1
+++ b/man/stap.1.in
@@ -87,6 +87,72 @@ stap \- systemtap script translator/driver
 ]
 .B \-\-dump-functions
 
+
+.SH "GETTING HELP"
+
+Stap comes with variety of educational, documentation and reference resources.
+They come either online, or packaged for offline use.  For online documentation,
+please, reach out to the project homesite, https://sourceware.org/systemtap/.
+
+If you are a newbie, read the
+.IR "Beginner's Guide" .
+It shows the basic ideas behind the tool, goes through the language essentials,
+and guides you through a few real life examples.
+See the online
+.IR "Documentation"
+section, or your distribution packages. 
+.IR "Systemtap Tutorial"
+goes more in-depth and comes with exercises.
+.IR "Language Reference"
+Is a detailed overview of the C and awk like syntactical constructs of the
+scripting language, as well as its less usual features like statistical data
+gathering and analysis.
+.IR "Tapset Reference"
+brings detailed overview of the extendable "standard" tapset library.  Last but
+not least, systemtap comes with a rich set of
+.IR example scripts .
+Many of them are directly usable sysadmin tools. See the project website, or
+your distribution packages, namely
+@prefix@/share/doc/systemtap*/examples.
+
+Following is an overview of available manual pages:
+
+.TP
+.BI stapprobes(3stap)
+The probe points and tapset aliases general reference.
+.TP
+.BI "function::*(3stap), probe::*(3stap), tapset::*(3stap)"
+Individual function, probe and tapset manpages. See
+@prefix@/share/man/man3/ for complete list.
+.TP
+.BI stappaths(7)
+Important systemtap paths.
+.TP
+.BI staprun(8)
+The Systemtap runtime driver backend.
+.TP
+.BI stapdyn(8)
+The Dyninst instrumentation backend.
+.TP
+.BI systemtap(8)
+The initscript service.
+.TP
+.BI stapvars(3stap)
+Public variables provided by the tapsets library.
+.TP
+.BI stapex(3stap)
+Gives the feel for basic systemtap syntax and control structures.
+.TP
+.BI stap-server(8)
+Systemtap's compile server facility.
+.TP
+.BI stap-prep(1)
+Dependency installer.
+.TP
+.BI stapref(1)
+Systemtap scripting language quick reference.
+
+
 .SH DESCRIPTION
 
 The