From 222bccafd8548194be47fbae578b3df3c636fd38 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Mon, 1 Jun 2020 15:47:54 +0200
Subject: Add man page and README
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 README    | 32 +++++++++++++++++++++++++++++++
 sctrace.1 | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 98 insertions(+)
 create mode 100644 README
 create mode 100644 sctrace.1

diff --git a/README b/README
new file mode 100644
index 0000000..3eb38b8
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+NAME
+	sctrace - Trace system calls
+
+SYNOPSIS
+	sctrace [-o trace-output-file] [-ft] (command | -0 command argv0) [argument] ...
+
+DESCRIPTION
+	sctrace starts the command specified in the command argument, with the
+	additional arguments specified in the argument arguments, and prints
+	information about all system calls it mades, to standard error (or the
+	file specified in the trace-output-file argument if the -o option is used).
+
+	sctrace will also print information about process termination, received signals,
+	and process suspension and continuation.
+
+OPTIONS
+	-0	This  options  specifies that the argv0 argument shall be inserted
+		immediately after the command argument. If this option is used, the
+		very first argument (typically called argv[0] in C programs) for the
+		trace process shall the string specified in the argv0 argument rather
+		than the command argument.
+
+	-f	Recursively trace all new children and threads. This option implies -t.
+
+	-o trace-output-file
+		Write trace outputs to the file specified in the trace-output-file
+		argument.
+
+	-t	Trace threads.
+
+SEE ALSO
+	ptrace(2), strace(1), ltrace(1)
diff --git a/sctrace.1 b/sctrace.1
new file mode 100644
index 0000000..61ebfd5
--- /dev/null
+++ b/sctrace.1
@@ -0,0 +1,66 @@
+.TH SCTRACE 1 SCTRACE
+.SH NAME
+sctrace - Trace system calls
+.SH SYNOPSIS
+.B sctrace
+.RB [ -o
+.IR trace-output-file ]
+.RB [ -ft ]
+.RI ( command " |"
+.B -0
+.I command
+.IR argv0 )
+.RI [ argument "] ..."
+.SH DESCRIPTION
+.B sctrace
+starts the command specified in the
+.I command
+argument, with the additional arguments
+specified in the
+.I argument
+arguments, and prints information about
+all system calls it mades, to standard
+error (or the file specified in the
+.I trace-output-file
+argument if the
+.B -o
+option is used).
+.PP
+.B sctrace
+will also print information about process
+termination, received signals, and process
+suspension and continuation.
+.SH OPTIONS
+.TP
+.B -0
+This options specifies that the
+.I argv0
+argument shall be inserted immediately
+after the
+.I command
+argument. If this option is used, the
+very first argument (typically called
+.I argv[0]
+in C programs) for the trace process shall
+the string specified in the
+.I argv0
+argument rather than the
+.I command
+argument.
+.TP
+.B -f
+Recursively trace all new children and threads.
+This option implies
+.BR -t .
+.TP
+.BR -o " "\fItrace-output-file\fI
+Write trace outputs to the file specified in the
+.I trace-output-file
+argument.
+.TP
+.B -t
+Trace threads.
+.SH "SEE ALSO"
+.BR ptrace (2),
+.BR strace (1),
+.BR ltrace (1)
-- 
cgit v1.2.3-70-g09d2