summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--ChangeLog8
-rw-r--r--Makefile.am2
-rw-r--r--Makefile.in8
-rwxr-xr-xconfigure3
-rw-r--r--configure.ac2
-rw-r--r--stap-server.8.in177
6 files changed, 194 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index d151735f..f73430f1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-08-29 Dave Brolley <brolley@redhat.com>
+
+ * stap-server.8.in: New man page.
+ * Makefile.am (man_MANS): Add stap-server.8.
+ * configure.ac (AC_CONFIG_FILE): Add stap-server.8.
+ * Makefile.in: Regenerated.
+ * configure: Regenerated.
+
2008-08-29 Stan Cox <scox@redhat.com>
* elaborate.cxx (add_global_var_display): Repopulate symbol/type info.
diff --git a/Makefile.am b/Makefile.am
index 867066bb..fe0fc408 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -10,7 +10,7 @@ AM_CPPFLAGS = -DBINDIR='"$(bindir)"' -DPKGDATADIR='"${pkgdatadir}"' -DPKGLIBDIR=
AM_CFLAGS = -D_GNU_SOURCE -fexceptions -Wall -Werror -Wunused -Wformat=2 -W
AM_CXXFLAGS = -Wall -Werror
-man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5
+man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5
# see also configure.ac
bin_PROGRAMS = stap staprun
diff --git a/Makefile.in b/Makefile.in
index 1d3225b8..ebd158dc 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -50,7 +50,7 @@ DIST_COMMON = INSTALL NEWS README AUTHORS ChangeLog \
$(srcdir)/config.in $(srcdir)/stap.1.in \
$(srcdir)/stapprobes.5.in $(srcdir)/stapfuncs.5.in \
$(srcdir)/stapvars.5.in $(srcdir)/stapex.5.in \
- $(srcdir)/staprun.8.in \
+ $(srcdir)/staprun.8.in $(srcdir)/stap-server.8.in \
$(top_srcdir)/man/stapprobes.iosched.5.in \
$(top_srcdir)/man/stapprobes.netdev.5.in \
$(top_srcdir)/man/stapprobes.nfs.5.in \
@@ -72,7 +72,7 @@ am__CONFIG_DISTCLEAN_FILES = config.status config.cache config.log \
mkinstalldirs = $(install_sh) -d
CONFIG_HEADER = config.h
CONFIG_CLEAN_FILES = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 \
- stapex.5 staprun.8 man/stapprobes.iosched.5 \
+ stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 \
man/stapprobes.netdev.5 man/stapprobes.nfs.5 \
man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 \
man/stapprobes.process.5 man/stapprobes.rpc.5 \
@@ -260,7 +260,7 @@ pkglibexecdir = ${libexecdir}/${PACKAGE}
AM_CPPFLAGS = -DBINDIR='"$(bindir)"' -DPKGDATADIR='"${pkgdatadir}"' -DPKGLIBDIR='"$(pkglibexecdir)"'
AM_CFLAGS = -D_GNU_SOURCE -fexceptions -Wall -Werror -Wunused -Wformat=2 -W
AM_CXXFLAGS = -Wall -Werror
-man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5
+man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5
bin_SCRIPTS = stap-client stap-server stap-serverd stap-find-servers stap-start-server stap-find-or-start-server stap-stop-server
stap_SOURCES = main.cxx \
parse.cxx staptree.cxx elaborate.cxx translate.cxx \
@@ -388,6 +388,8 @@ stapex.5: $(top_builddir)/config.status $(srcdir)/stapex.5.in
cd $(top_builddir) && $(SHELL) ./config.status $@
staprun.8: $(top_builddir)/config.status $(srcdir)/staprun.8.in
cd $(top_builddir) && $(SHELL) ./config.status $@
+stap-server.8: $(top_builddir)/config.status $(srcdir)/stap-server.8.in
+ cd $(top_builddir) && $(SHELL) ./config.status $@
man/stapprobes.iosched.5: $(top_builddir)/config.status $(top_srcdir)/man/stapprobes.iosched.5.in
cd $(top_builddir) && $(SHELL) ./config.status $@
man/stapprobes.netdev.5: $(top_builddir)/config.status $(top_srcdir)/man/stapprobes.netdev.5.in
diff --git a/configure b/configure
index d1fe6a30..71413615 100755
--- a/configure
+++ b/configure
@@ -7190,7 +7190,7 @@ ac_compiler_gnu=$ac_cv_c_compiler_gnu
ac_config_headers="$ac_config_headers config.h:config.in"
-ac_config_files="$ac_config_files Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5"
+ac_config_files="$ac_config_files Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5"
subdirs="$subdirs testsuite"
@@ -7824,6 +7824,7 @@ do
"stapvars.5") CONFIG_FILES="$CONFIG_FILES stapvars.5" ;;
"stapex.5") CONFIG_FILES="$CONFIG_FILES stapex.5" ;;
"staprun.8") CONFIG_FILES="$CONFIG_FILES staprun.8" ;;
+ "stap-server.8") CONFIG_FILES="$CONFIG_FILES stap-server.8" ;;
"man/stapprobes.iosched.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.iosched.5" ;;
"man/stapprobes.netdev.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.netdev.5" ;;
"man/stapprobes.nfs.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.nfs.5" ;;
diff --git a/configure.ac b/configure.ac
index 4ad54f7c..123ac657 100644
--- a/configure.ac
+++ b/configure.ac
@@ -231,7 +231,7 @@ AC_CHECK_HEADERS([tr1/unordered_map])
AC_LANG_POP(C++)
AC_CONFIG_HEADERS([config.h:config.in])
-AC_CONFIG_FILES(Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5)
+AC_CONFIG_FILES(Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5)
AC_CONFIG_SUBDIRS(testsuite)
AC_OUTPUT
diff --git a/stap-server.8.in b/stap-server.8.in
new file mode 100644
index 00000000..9bfaa789
--- /dev/null
+++ b/stap-server.8.in
@@ -0,0 +1,177 @@
+.\" -*- nroff -*-
+.TH STAP-SERVER 8 @DATE@ "Red Hat"
+.SH NAME
+stap-server \- systemtap server and related utilities
+
+.SH SYNOPSIS
+
+.br
+.B stap-start-server
+.br
+.B stap-find-servers
+[
+.B --all
+]
+.br
+.B stap-find-or-start-server
+.br
+.B stap-stop-server
+.I PID
+.br
+.B stap-client
+[
+.I ARGUMENTS
+]
+
+.SH DESCRIPTION
+
+The systemtap server listens for connections from
+.I stap-client
+on the local network and accepts requests to run the
+.I stap
+front end.
+
+.PP
+The
+.I stap-start-server
+program attempts to start a systemtap server (
+.I stap-serverd
+) on the local host. Upon
+successful startup, the server listens for connections on a random port and
+advertises its presence on the local network using the
+.I avahi
+daemon. If the server is successfully started, its process id is
+echoed to stdout and the exit code is 0. Otherwise, nothing is echoed and the exit code is 1.
+
+.PP
+The
+.I stap-find-servers
+program attempts to find systemtap servers running on the local network.
+The details of any servers found are echoed to stdout.
+If servers are found, then the exit code is 0, otherwise it is 1.
+
+.PP
+The
+.I stap-find-or-start-server
+program attempts to find a compatible systemtap server running on the local network
+using
+.I stap-find-servers.
+If a compatible server is found,
+.I stap-find-or-start-server
+echos '0' to stdout and the exit code is 0. Otherwise
+.I stap-find-or-start-server
+attempts to start a server on the local network using
+.I stap-start-server.
+If successful, the process id of the new server is echoed to stdout and the
+exit code is 0. If no server can be found or started, nothing is echoed
+to stdout and the exit code is 1.
+
+.PP
+The
+.I stap-stop-server
+program verifies that the given process id is that of a running systemtap server
+on the local host and, if so, attempts to shut down the server by sending it the
+SIGTERM signal. If a process id is provided and it is that of a running systemtap
+server, the exit code is 0. Otherwise the exit code is 1.
+.I stap-stop-server
+does not verify that the server actually shuts down.
+
+.PP
+The
+.I stap-client
+program is analagous to the
+.I stap
+front end except that it attempts to find a compatible systemtap server on the
+local network and then attempts to use that server for actions related to
+passes 1 through 4. Pass 5 actions, if requested, are performed on the localhost
+using
+.I staprun
+. Upon successful completion, the exit code is 0. Otherwise the exit code
+is 1.
+
+.SH OPTIONS
+The
+.I stap-find-servers
+program supports the following option. Any other option
+is ignored.
+.TP
+.B \--all
+Instructs
+.I stap-find-servers
+to report all systemtap servers on the local network regardless of compatibility.
+The default behavior is to report only servers which are compatible with
+systemtap on the local host.
+
+.SH ARGUMENTS
+The
+.I stap-stop-server
+program requires a process id argument which identifies the server to be stopped.
+
+.PP
+The
+.I stap-client
+program accepts the same arguments and options as the
+.I stap
+front end.
+
+.SH EXAMPLES
+See the
+.IR stapex (5)
+manual page for a collection of sample scripts.
+.PP
+Here is a very basic example of how to use
+.I stap-client.
+.PP
+To find out if a compatible systemtap server is running on your local network
+.PP
+\& $ stap-find-servers
+.PP
+If no servers are reported, you can start one using
+.PP
+\& $ stap-start-server
+.PP
+You could also have accomplished both of the previous two steps using
+.PP
+\& $ stap-find-or-start-server
+.PP
+To compile and execute a simple example using the server
+.PP
+\& $ stap-client \-e \[aq]probe begin { printf("Hello World!\\n"); exit() }\[aq]
+.br
+\& Hello World!
+.PP
+If a process id was echoed by
+.I stap-start-server
+or
+.I stap-find-or-start-server
+then you can stop the server using
+.PP
+\& $ stap-stop-server PID
+.PP
+where PID is the process id that was echoed.
+
+
+.SH SAFETY AND SECURITY
+Systemtap is an administrative tool. It exposes kernel internal data
+structures and potentially private user information. See the
+.IR stap (1)
+manual page for additional information on safety and security.
+
+.PP
+The systemtap server and its related utilities are prototypes only. NO NETWORK
+SECURITY OF ANY KIND IS CURRENTLY PROVIDED. These programs should only be used
+among trusted hosts on a trusted network.
+
+.SH SEE ALSO
+.IR stap (1),
+.IR staprun (8),
+.IR stapprobes (5),
+.IR stapfuncs (5),
+.IR stapex (5),
+
+.SH BUGS
+Use the Bugzilla link off of the project web page or our mailing list.
+.nh
+.BR http://sources.redhat.com/systemtap/ ", " <systemtap@sources.redhat.com> .
+.hy
+
generated by cgit (git 2.34.1) at 2025-08-05 07:22:10 +0000