From: Sven Höxter <sven.hoexter@rewe-digital.com>
Date: Fri, 6 Sep 2019 13:27:47 +0000 (+0200)
Subject: add a minimal manpage
X-Git-Tag: debian/1.5-1~5
X-Git-Url: https://git.sven.stormbind.net/?p=sven%2Fjattach.git;a=commitdiff_plain;h=6803695dfc497f6cabb34f11e5c6f57a53e0d2db

add a minimal manpage
---

diff --git a/debian/jattach.1 b/debian/jattach.1
new file mode 100644
index 0000000..a12608d
--- /dev/null
+++ b/debian/jattach.1
@@ -0,0 +1,56 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" (C) Copyright 2019 Sven Hoexter <sven@stormbind.net>,
+.\"
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH JATTACH 1 "September 06 2019"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+jattach \- dynamc attach utility for the jvm
+.SH SYNOPSIS
+.B jattach
+.RI "pid [load|properties|agentProperties|datadump|threaddump|dumpheap|inspectheap|setflag|printflag|jcmd] [args]"
+.SH DESCRIPTION
+jattach is an all in one jamp, jstack, jcmd, jinfo implementation as a tiny single C program.
+.SH OPTIONS
+.B load
+load agent library
+.PP
+.B properties
+print system properties
+.PP
+.B agentProperties
+print agent properties
+.PP
+.B datadump
+show heap and thread summary
+.PP
+.B threaddump
+dump all stack traces (like jstack)
+.PP
+.B dumpheap
+dump heap (like jmap)
+.PP
+.B inspectheap
+create a heap histrogram (like jmap -histo)
+.PP
+.B setflag
+modify manageable JVM flag
+.PP
+.B printflag
+print JVM flag
+.PP
+.B jcmd
+execute jcmd command
diff --git a/debian/manpage.1.ex b/debian/manpage.1.ex
deleted file mode 100644
index 74cb296..0000000
--- a/debian/manpage.1.ex
+++ /dev/null
@@ -1,56 +0,0 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2019 sven <sven@digital0638.lan>,
-.\"
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH Jattach SECTION "August 22 2019"
-.\" Please adjust this date whenever revising the manpage.
-.\"
-.\" Some roff macros, for reference:
-.\" .nh        disable hyphenation
-.\" .hy        enable hyphenation
-.\" .ad l      left justify
-.\" .ad b      justify to both left and right margins
-.\" .nf        disable filling
-.\" .fi        enable filling
-.\" .br        insert line break
-.\" .sp <n>    insert n+1 empty lines
-.\" for manpage-specific macros, see man(7)
-.SH NAME
-jattach \- program to do something
-.SH SYNOPSIS
-.B jattach
-.RI [ options ] " files" ...
-.br
-.B bar
-.RI [ options ] " files" ...
-.SH DESCRIPTION
-This manual page documents briefly the
-.B jattach
-and
-.B bar
-commands.
-.PP
-.\" TeX users may be more comfortable with the \fB<whatever>\fP and
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
-.\" respectively.
-\fBjattach\fP is a program that...
-.SH OPTIONS
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes (`-').
-A summary of options is included below.
-For a complete description, see the Info files.
-.TP
-.B \-h, \-\-help
-Show summary of options.
-.TP
-.B \-v, \-\-version
-Show version of program.
-.SH SEE ALSO
-.BR bar (1),
-.BR baz (1).
-.br
-The programs are documented fully by
-.IR "The Rise and Fall of a Fooish Bar" ,
-available via the Info system.
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..2431ec9
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/jattach.1