README.md: improve markup

This commit is contained in:
Matteo Cypriani 2016-11-02 01:16:55 +01:00
parent 6dbd036eea
commit 150a89bb40
1 changed files with 13 additions and 14 deletions

View File

@ -1,4 +1,4 @@
pstack - print stack trace of running processes # pstack - print stack trace of running processes
pstack dumps a stack trace for a process, given the pid of that pstack dumps a stack trace for a process, given the pid of that
process. If the process named is part of a thread group, then all the threads process. If the process named is part of a thread group, then all the threads
@ -6,8 +6,9 @@ inthe group are traced. See the man page for more information.
This program was inspired by the 'pstack' program available on Solaris. This program was inspired by the 'pstack' program available on Solaris.
SUPPORTED PLATFORMS: ## Supported Platforms
This program runs on 32 bit x86 machines, using ELF binaries
This program runs on 32 bit x86 machines, using ELF binaries
generated from GNU compilers. If threads are being used, it depends generated from GNU compilers. If threads are being used, it depends
on a debuggable version of the pthreads library to find the threads in on a debuggable version of the pthreads library to find the threads in
the thread group. If anyone wants to port this to other the thread group. If anyone wants to port this to other
@ -15,22 +16,20 @@ architectures, please let me know about questions you may have, or
achievements you have made. I'd like to incorporate such changes into achievements you have made. I'd like to incorporate such changes into
my version of the code. my version of the code.
FEATURES: ## Features
symbolic address dumping
thread group support
BUILD: * symbolic address dumping
make * thread group support
INSTALL: ## Build, install, uninstall
make install
UNINSTALL: make
make uninstall make install
make uninstall
NOTE: you must be root to [un]install. pstack will run fine from any **Note:** you must be root to [un]install. pstack will run fine from any
directory, install just puts the binary and man page in 'normal' directory, install just puts the binary and man page in 'normal'
places (/usr/local/...) places (`/usr/local/...`)
USAGE: USAGE:
pstack pid [...] pstack pid [...]