add a minimal manpage

[sven/jattach.git] / debian / jattach.1

diff --git a/debian/jattach.1 b/debian/jattach.1
new file mode 100644 (file)
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