-
Notifications
You must be signed in to change notification settings - Fork 310
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates to the man page on formatting and styling conventions #157
Open
aweeraman
wants to merge
1
commit into
microsoft:master
Choose a base branch
from
aweeraman:man-page-enhancements
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,105 @@ | ||
.\" Manpage for procdump. | ||
.TH man 8 "12/12/2022" "1.4" "procdump manpage" | ||
.TH PROCDUMP 1 "1/28/2023" "procdump" "User Commands" | ||
.SH NAME | ||
procdump \- generate coredumps based off performance triggers. | ||
procdump \- generate coredumps based on performance triggers. | ||
.SH SYNOPSIS | ||
procdump [-n Count] | ||
[-s Seconds] | ||
[-c|-cl CPU_Usage] | ||
[-m|-ml Commit_Usage] | ||
[-tc Thread_Threshold] | ||
[-fc FileDescriptor_Threshold] | ||
[-sig Signal_Number] | ||
[-e] | ||
[-f Include_Filter,...] | ||
[-pf Polling_Frequency] | ||
[-o] | ||
[-log] | ||
{ | ||
{{[-w] Process_Name | [-pgid] PID} [Dump_File | Dump_Folder]} | ||
} | ||
|
||
Options: | ||
-n Number of dumps to write before exiting. | ||
-s Consecutive seconds before dump is written (default is 10). | ||
-c CPU threshold above which to create a dump of the process. | ||
-cl CPU threshold below which to create a dump of the process. | ||
-m Memory commit threshold in MB at which to create a dump. | ||
-ml Trigger when memory commit drops below specified MB value. | ||
-tc Thread count threshold above which to create a dump of the process. | ||
-fc File descriptor count threshold above which to create a dump of the process. | ||
-sig Signal number to intercept to create a dump of the process. | ||
-e [.NET] Create dump when the process encounters an exception. | ||
-f [.NET] Filter (include) on the (comma seperated) exception name(s). | ||
-pf Polling frequency. | ||
-o Overwrite existing dump file. | ||
-log Writes extended ProcDump tracing to syslog. | ||
-w Wait for the specified process to launch if it's not running. | ||
-pgid Process ID specified refers to a process group ID. | ||
|
||
.B procdump | ||
[ | ||
.B -n | ||
.I count | ||
] [ | ||
.B -s | ||
.I seconds | ||
] [ | ||
.B -c|-cl | ||
.I CPU usage | ||
] [ | ||
.B -m|-ml | ||
.I usage | ||
] [ | ||
.B -tc | ||
.I threshold | ||
] [ | ||
.B -fc | ||
.I threshold | ||
] [ | ||
.B -sig | ||
.I number | ||
] [ | ||
.B -e | ||
] [ | ||
.B -f | ||
.I filter,... | ||
] [ | ||
.B -pf | ||
.I frequency | ||
] [ | ||
.B -o | ||
] [ | ||
.B -log | ||
] [[ [ | ||
.B -w | ||
.I name | ||
] | ||
| [ | ||
.B -pgid | ||
.I pid | ||
] | ||
] [ | ||
.I file | ||
| | ||
.I folder | ||
]] | ||
.SH DESCRIPTION | ||
procdump is a Linux reimagining of the class ProcDump tool from the Sysinternals suite of tools for Windows. Procdump provides a convenient way for Linux developers to create core dumps of their application based on performance triggers. | ||
.SH OPTIONS | ||
.TP | ||
.B -n | ||
Number of dumps to write before exiting. | ||
.TP | ||
.B -s | ||
Consecutive seconds before dump is written (default is 10). | ||
.TP | ||
.B -c | ||
CPU threshold above which to create a dump of the process. | ||
.TP | ||
.B -cl | ||
CPU threshold below which to create a dump of the process. | ||
.TP | ||
.B -m | ||
Memory commit threshold in MB at which to create a dump. | ||
.TP | ||
.B -ml | ||
Trigger when memory commit drops below specified MB value. | ||
.TP | ||
.B -tc | ||
Thread count threshold above which to create a dump of the process. | ||
.TP | ||
.B -fc | ||
File descriptor count threshold above which to create a dump of the process. | ||
.TP | ||
.B -sig | ||
Signal number to intercept to create a dump of the process. | ||
.TP | ||
.B -e | ||
[.NET] Create dump when the process encounters an exception. | ||
.TP | ||
.B -f | ||
[.NET] Filter (include) on the (comma separated) exception name(s). | ||
.TP | ||
.B -pf | ||
Polling frequency. | ||
.TP | ||
.B -o | ||
Overwrite existing dump file. | ||
.TP | ||
.B -log | ||
Writes extended ProcDump tracing to syslog. | ||
.TP | ||
.B -w | ||
Wait for the specified process to launch if it's not running. | ||
.TP | ||
.B -pgid | ||
Process ID specified refers to a process group ID. | ||
.SH COPYRIGHT | ||
Copyright (C) Microsoft Corporation. All rights reserved. Licensed under the MIT license. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
zaru