File: pquery.1

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 201,684 kB
  • sloc: ansic: 613,078; makefile: 42,353; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (105 lines) | stat: -rw-r--r-- 3,032 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.\" Man page generated from reStructuredText.
.
.TH "PQUERY" "1" "May 30, 2025" "" "OpenPMIx"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
pquery — query information from the host environment
.SH SYNOPSIS
.sp
\fBpquery [options] <KEY1>,<KEY2>,...\fP
.SH DESCRIPTION
.sp
\fBpquery\fP requests the host environment for values associated
with the provided keys
.SH OPTIONS
.sp
\fBpquery\fP accepts the following options:
.INDENT 0.0
.IP \(bu 2
\fB\-h\fP | \fB\-\-help <arg0>\fP: Show help message. If the optional
argument is not provided, then a generalized help message similar
to the information provided here is returned. If an argument is
provided, then a more detailed help message for that specific
command line option is returned.
.IP \(bu 2
\fB\-v\fP | \fB\-\-verbose\fP: Enable debug output.
.IP \(bu 2
\fB\-V\fP | \fB\-\-version\fP: Print version and exit.
.IP \(bu 2
\fB\-\-pmixmca <arg0> <arg1>\fP: Set MCA parameter value
.IP \(bu 2
\fB\-\-uri <arg0>\fP: Specify the URI of the server to which we are to connect, or
the name of the file (specified as \fI\%file:filename\fP) that contains that info
.IP \(bu 2
\fB\-\-namespace <arg0>\fP: Namespace of the daemon to which we should connect
.IP \(bu 2
\fB\-\-pid <arg0>\fP: PID of the daemon to which we should connect (int => PID or file:<file>
for file containing the PID
.IP \(bu 2
\fB\-\-system\-server\-first\fP: First look for a system server and connect to it if found
.IP \(bu 2
\fB\-\-system\-server\fP: Connect to a system\-level server
.IP \(bu 2
\fB\-\-tmpdir <arg0>\fP: Set the root for the session directory tree
.IP \(bu 2
\fB\-\-wait\-to\-connect <arg0>\fP: Delay specified number of seconds before trying to connect
.IP \(bu 2
\fB\-\-num\-connect\-retries <arg0>\fP: Max number of times to try to connect
.UNINDENT
.sp
Keys passed to pquery may optionally include one or more qualifiers, with the
individual qualifiers delimited by semi\-colons. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ pquery "PMIX_STORAGE_XFER_SIZE[PMIX_STORAGE_ID=lustre1,lustre2;PMIX_STORAGE_PATH=foo]""
.ft P
.fi
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
Returns 0 for success, or a non\-zero value otherwise. Values returned by the query
are printed to stdout.
.SH EXAMPLES
.sp
Examples of using this command.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%openpmix(5)\fP
.UNINDENT
.UNINDENT
.SH COPYRIGHT
2014-2025, OpenPMIx Community
.\" Generated by docutils manpage writer.
.