qsig(1p) - f34

1QSIG(1P)                   POSIX Programmer's Manual                  QSIG(1P)
2
3
4

PROLOG

6       This  manual  page is part of the POSIX Programmer's Manual.  The Linux
7       implementation of this interface may differ (consult the  corresponding
8       Linux  manual page for details of Linux behavior), or the interface may
9       not be implemented on Linux.
10

NAME

12       qsig — signal batch jobs
13

SYNOPSIS

15       qsig [-s signal] job_identifier...
16

DESCRIPTION

18       To signal a batch job is to send a signal to the session leader of  the
19       batch  job.  A  batch job is signaled by sending a request to the batch
20       server that manages the batch job. The qsig utility is a  user-accessi‐
21       ble batch client that requests the signaling of a batch job.
22
23       The  qsig  utility  shall  signal  those  batch  jobs for which a batch
24       job_identifier is presented to the utility. The qsig utility shall  not
25       signal  any batch jobs whose batch job_identifiers are not presented to
26       the utility.
27
28       The qsig utility shall signal batch jobs in the order in which the cor‐
29       responding  batch  job_identifiers are presented to the utility. If the
30       qsig utility fails to process a batch job_identifier successfully,  the
31       utility  shall  proceed to process the remaining batch job_identifiers,
32       if any.
33
34       The qsig utility shall signal  batch  jobs  by  sending  a  Signal  Job
35       Request to the batch server that manages the batch job.
36
37       For  each successfully processed batch job_identifier, the qsig utility
38       shall have received a completion reply to each Signal Job Request  sent
39       to a batch server at the time the utility exits.
40

OPTIONS

42       The  qsig  utility  shall  conform  to  the  Base Definitions volume of
43       POSIX.1‐2017, Section 12.2, Utility Syntax Guidelines.
44
45       The following option shall be supported by the implementation:
46
47       -s signal Define the signal to be sent to the batch job.
48
49                 The qsig utility shall accept a signal  option-argument  that
50                 is  either a symbolic signal name or an unsigned integer sig‐
51                 nal number (see the POSIX.1‐1990 standard, Section  3.3.1.1).
52                 The  qsig utility shall accept signal names for which the SIG
53                 prefix has been omitted.
54
55                 If the signal option-argument is  a  signal  name,  the  qsig
56                 utility shall send that name.
57
58                 If  the  signal option-argument is a number, the qsig utility
59                 shall send the signal value represented by the number.
60
61                 If the -s option is not presented to the  qsig  utility,  the
62                 utility  shall send the signal SIGTERM to each signaled batch
63                 job.
64

OPERANDS

66       The qsig utility shall accept one or more operands that conform to  the
67       syntax for a batch job_identifier (see Section 3.3.1, Batch Job Identi‐
68       fier).
69

STDIN

71       Not used.
72

INPUT FILES

74       None.
75

ENVIRONMENT VARIABLES

77       The following environment variables shall affect the execution of qsig:
78
79       LANG      Provide a default value for  the  internationalization  vari‐
80                 ables  that are unset or null. (See the Base Definitions vol‐
81                 ume of POSIX.1‐2017, Section 8.2, Internationalization  Vari‐
82                 ables  the  precedence of internationalization variables used
83                 to determine the values of locale categories.)
84
85       LC_ALL    If set to a non-empty string value, override  the  values  of
86                 all the other internationalization variables.
87
88       LC_CTYPE  Determine  the  locale for the interpretation of sequences of
89                 bytes of text data as characters (for example, single-byte as
90                 opposed to multi-byte characters in arguments).
91
92       LC_MESSAGES
93                 Determine the locale that should be used to affect the format
94                 and contents  of  diagnostic  messages  written  to  standard
95                 error.
96
97       LOGNAME   Determine the login name of the user.
98

ASYNCHRONOUS EVENTS

100       Default.
101

STDOUT

103       An implementation of the qsig utility may write informative messages to
104       standard output.
105

STDERR

107       The standard error shall be used only for diagnostic messages.
108

OUTPUT FILES

110       None.
111

EXTENDED DESCRIPTION

113       None.
114

EXIT STATUS

116       The following exit values shall be returned:
117
118        0    Successful completion.
119
120       >0    An error occurred.
121

CONSEQUENCES OF ERRORS

123       In addition to the default behavior, the  qsig  utility  shall  not  be
124       required to write a diagnostic message to standard error when the error
125       reply received from a batch server indicates that the batch job_identi‐
126       fier  does  not  exist  on  the server. Whether or not the qsig utility
127       waits to output the diagnostic message while attempting to  locate  the
128       batch job on other servers is implementation-defined.
129
130       The following sections are informative.
131

APPLICATION USAGE

133       None.
134

EXAMPLES

136       None.
137

RATIONALE

139       The qsig utility allows users to signal batch jobs.
140
141       A user may be unable to signal a batch job with the kill utility of the
142       operating system for a number of reasons. First, the process ID of  the
143       batch  job  may  be  unknown  to the user. Second, the processes of the
144       batch job may be on a remote node. However, by virtue of  communication
145       between  batch nodes, the qsig utility can arrange for the signaling of
146       a process.
147
148       Because a batch job that is not running cannot be signaled, and because
149       the  signal  may not terminate the batch job, the qsig utility is not a
150       substitute for the qdel utility.
151
152       The options of the qsig utility allow the user to  specify  the  signal
153       that is to be sent to the batch job.
154
155       The  -s  option  allows users to specify a signal by name or by number,
156       and thus override the default signal. The POSIX.1‐1990 standard defines
157       signals by both name and number.
158
159       The  qsig utility is a new utility, vis-a-vis existing practice; it has
160       been defined in this volume of POSIX.1‐2017 in  response  to  user-per‐
161       ceived shortcomings in existing practice.
162

FUTURE DIRECTIONS

164       The qsig utility may be removed in a future version.
165

COPYRIGHT

173       Portions of this text are reprinted and reproduced in  electronic  form
174       from  IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
175       table Operating System Interface (POSIX), The Open Group Base  Specifi‐
176       cations  Issue  7, 2018 Edition, Copyright (C) 2018 by the Institute of
177       Electrical and Electronics Engineers, Inc and The Open Group.   In  the
178       event of any discrepancy between this version and the original IEEE and
179       The Open Group Standard, the original IEEE and The Open Group  Standard
180       is  the  referee document. The original Standard can be obtained online
181       at http://www.opengroup.org/unix/online.html .
182
183       Any typographical or formatting errors that appear  in  this  page  are
184       most likely to have been introduced during the conversion of the source
185       files to man page format. To report such errors,  see  https://www.ker‐
186       nel.org/doc/man-pages/reporting_bugs.html .
187
188
189
190IEEE/The Open Group                  2017                             QSIG(1P)