Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes introduce new folder as doc to store any documentation related VMA library. As a part of this commit man folder is added with man pages for vma, vma daemon and vma_stats. Signed-off-by: Igor Ivanov <igor.ivanov.va@gmail.com>
- Loading branch information
1 parent
6a1e807
commit b9aabc0
Showing
9 changed files
with
188 additions
and
4 deletions.
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
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
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
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 +1,2 @@ | ||
usr/bin/vma_stats | ||
usr/share/man/man8/vma_stats.* |
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
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 |
---|---|---|
@@ -0,0 +1,24 @@ | ||
vma_man_pages = \ | ||
vma.7 \ | ||
vmad.8 \ | ||
vma_stats.8 | ||
|
||
man_MANS = $(vma_man_pages) | ||
CLEANFILES = $(vma_man_pages) | ||
EXTRA_DIST = \ | ||
$(vma_man_pages:.7=.7.in) \ | ||
$(vma_man_pages:.8=.8.in) | ||
|
||
%.7: %.7.in | ||
@cp $< $@ | ||
@sed -i 's/#BUILD_DATE#/@BUILD_DATE@/g' $@ | ||
@sed -i 's/#VMA_LIBRARY_MAJOR#/@VMA_LIBRARY_MAJOR@/g' $@ | ||
@sed -i 's/#VMA_LIBRARY_MINOR#/@VMA_LIBRARY_MINOR@/g' $@ | ||
@sed -i 's/#VMA_LIBRARY_REVISION#/@VMA_LIBRARY_REVISION@/g' $@ | ||
|
||
%.8: %.8.in | ||
@cp $< $@ | ||
@sed -i 's/#BUILD_DATE#/@BUILD_DATE@/g' $@ | ||
@sed -i 's/#VMA_LIBRARY_MAJOR#/@VMA_LIBRARY_MAJOR@/g' $@ | ||
@sed -i 's/#VMA_LIBRARY_MINOR#/@VMA_LIBRARY_MINOR@/g' $@ | ||
@sed -i 's/#VMA_LIBRARY_REVISION#/@VMA_LIBRARY_REVISION@/g' $@ |
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 |
---|---|---|
@@ -0,0 +1,42 @@ | ||
.\" -*- groff -*- | ||
.\" | ||
.TH VMA 7 "#BUILD_DATE#" libvma "VMA(#VMA_LIBRARY_MAJOR#.#VMA_LIBRARY_MINOR#.#VMA_LIBRARY_REVISION#) User's Manual" | ||
.SH NAME | ||
VMA \- Mellanox's Messaging Accelerator (VMA) library. | ||
|
||
.SH SYNOPSIS | ||
.B libvma.so | ||
|
||
.SH DESCRIPTION | ||
.B VMA | ||
Mellanox's Messaging Accelerator (VMA) boosts performance for message-based | ||
and streaming applications such as those found in financial services market | ||
data environments and Web2.0 clusters. It allows application written over | ||
standard socket API to run over Ethernet and/or Infiniband from user-space | ||
with full network stack bypass. The result is a reduction in latency by as | ||
much as 300%, an increase in application throughput by as much as 200%, higher | ||
packets rates and better CPU utilization as compared to applications running | ||
on standard Ethernet or InfiniBand interconnect networks. | ||
|
||
.SH FILES | ||
.I /etc/libvma.conf | ||
.RS | ||
The system wide configuration file. Look inside libvma.conf for instructions | ||
and examples. | ||
.RE | ||
.I /usr/share/doc/libvma/README.txt | ||
.RS | ||
General VMA Library description. | ||
.RE | ||
.I /usr/share/doc/libvma/VMA_VERSION | ||
.RS | ||
VMA Library version information. | ||
.RE | ||
|
||
.SH SEE ALSO | ||
.BR vmad (8), | ||
.BR vma_stats (8) | ||
|
||
.SH "AUTHORS" | ||
.TP | ||
Igor Ivanov <igori@mellanox.com> |
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 |
---|---|---|
@@ -0,0 +1,70 @@ | ||
.\" -*- groff -*- | ||
.\" | ||
.TH VMA 8 "#BUILD_DATE#" libvma "VMA(#VMA_LIBRARY_MAJOR#.#VMA_LIBRARY_MINOR#.#VMA_LIBRARY_REVISION#) User's Manual" | ||
.SH NAME | ||
vma_stats \- Mellanox's Messaging Accelerator (VMA) statistic utility. | ||
|
||
.SH SYNOPSIS | ||
.B vma_stats | ||
[\-p \fIpid\fP] [\-k \fIdirectory\fP] [\-v \fIview\fP] [\-d \fIdetails\fP] [\-i \fIinterval\fP] | ||
[\-n \fIapplication\fP] [\-f] [\-F] [\-c \fIcycles\fP] [\-l \fIlevel\fP] [\-z] | ||
|
||
.SH DESCRIPTION | ||
vma_stats is program that reports information about sockets and internal related objects for vma (7). | ||
vma_stats can be configured using command-line options | ||
|
||
The options are as follows: | ||
.sp | ||
\fB\-p,\-\-pid\fP \fIid\fP | ||
Show VMA statistics for process with pid. | ||
.TP | ||
\fB\-k,\-\-directory\fP=\fIdirectory\fP | ||
Set shared memory directory path. | ||
.TP | ||
\fB\-n,\-\-name\fP=\fIapplication\fP | ||
Show VMA statistics for application. | ||
.TP | ||
\fB\-f,\-\-find_pid\fP | ||
Find and show statistics for VMA instance running. | ||
.TP | ||
\fB\-F,\-\-forbid_clean\fP | ||
By setting this flag inactive shared objects would not be removed. | ||
.TP | ||
\fB\-i,\-\-interval\fP=\fIinterval\fP | ||
Print report every interval seconds. | ||
.TP | ||
\fB\-c,\-\-cycles\fP=\fIcycles\fP | ||
Do report print cycles and exit, use 0 value for infinite. | ||
.TP | ||
\fB\-v,\-\-view\fP=\fI[1|2|3|4|5]\fP | ||
Set view type: 1\- basic info, 2\- extra info, 3\- full info, 4\- mc groups, 5\- similar to 'netstat \-tunaep'. | ||
.TP | ||
\fB\-d,\-\-details\fP=\fI[1|2]\fP | ||
Set details mode:1\- to see totals, 2\- to see deltas. | ||
.TP | ||
\fB\-z,\-\-zero\fP | ||
Zero counters. | ||
.TP | ||
\fB\-l,\-\-log_level\fP=\fIlevel\fP | ||
Set VMA log level (one of: none, panic, error, warn, info, details, debug, fine, finer, all). | ||
.TP | ||
\fB\-S,\-\-fd_dump\fP=\fIfd [level]\fP | ||
Dump statistics for fd number using log level. Use 0 value for all open fds. | ||
.TP | ||
\fB\-D,\-\-details_level\fP=\fIlevel\fP | ||
Set VMA log details level. | ||
.TP | ||
\fB\-s,\-\-sockets\fP=\fI[list|range]\fP | ||
Log only sockets that match list or range, format: 4-16 or 1,9 (or combination). | ||
.TP | ||
\fB\-V,\-\-version\fP | ||
Print version. | ||
.TP | ||
|
||
.SH SEE ALSO | ||
.BR vma (7), | ||
.BR vmad (8) | ||
|
||
.SH "AUTHORS" | ||
.TP | ||
Igor Ivanov <igori@mellanox.com> |
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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
.\" -*- groff -*- | ||
.\" | ||
.TH VMA 8 "#BUILD_DATE#" libvma "VMA(#VMA_LIBRARY_MAJOR#.#VMA_LIBRARY_MINOR#.#VMA_LIBRARY_REVISION#) User's Manual" | ||
.SH NAME | ||
vmad \- Mellanox's Messaging Accelerator (VMA) daemon. | ||
|
||
.SH SYNOPSIS | ||
.B vmad | ||
[\-\-console] [\-\-pid,-p \fInum\fP] [\-\-fid,-f \fInum\fP] | ||
[\-\-force-rst] [\-\-verbose,\-v \fIlevel\fP] | ||
|
||
.SH DESCRIPTION | ||
vmad is the daemon program for vma (7). | ||
|
||
vmad can be configured using command-line options | ||
|
||
The options are as follows: | ||
.sp | ||
\fB\-\-console\fP | ||
Enable foreground mode. | ||
.TP | ||
\fB\-\-pid,\-p \fP\fInum\fP | ||
Set prime number as maximum of processes per node. | ||
.TP | ||
\fB\-\-fid,\-f \fP\fInum\fP | ||
Set prime number as maximum of sockets per process. | ||
.TP | ||
\fB\-\-force\-rst\fP | ||
Force internal RST. | ||
.TP | ||
\fB\-\-verbose,\-v \fP\fIlevel\fP | ||
Output verbose level | ||
.TP | ||
|
||
.SH SEE ALSO | ||
.BR vma (7), | ||
.BR vma_stats (8) | ||
|
||
.SH "AUTHORS" | ||
.TP | ||
Igor Ivanov <igori@mellanox.com> |