summaryrefslogtreecommitdiff
path: root/usr/src/man
diff options
context:
space:
mode:
authorJerry Jelinek <jerry.jelinek@joyent.com>2020-06-03 11:38:44 +0000
committerJerry Jelinek <jerry.jelinek@joyent.com>2020-06-03 11:38:44 +0000
commit1c5ac86169ba0e28b070d8b7f6c787be64bce7e4 (patch)
tree984f229706437e50b866d25cd3aced33f9358a5f /usr/src/man
parented13e9ae4cee8abfe808486d0e0d7ee69b8fc256 (diff)
parentd15d17d4231f87f1571fa6d585377206f360f667 (diff)
downloadillumos-joyent-1c5ac86169ba0e28b070d8b7f6c787be64bce7e4.tar.gz
[illumos-gate merge]
commit d15d17d4231f87f1571fa6d585377206f360f667 12786 fix CTF pointer overrun commit 8fff788790878e3c95666decd46960ecc74c1c69 12721 would like svcadm disable -c commit 87be0d9605ee884229638b6fd168fa7165e109a3 12813 pptadm and libppt are x86 only commit 069e6b7e31ba5dcbc5441b98af272714d9a5455c 12708 Packages could be linted 12717 Stop ignoring pkgdepend errors commit 605d010da59abaf92279a7caed83515cbb3218dc 7510 enable highres clock usage for non-privileged users Conflicts: usr/src/man/man3c/timer_settime.3c
Diffstat (limited to 'usr/src/man')
-rw-r--r--usr/src/man/man1/svcs.123
-rw-r--r--usr/src/man/man1m/svcadm.1m23
-rw-r--r--usr/src/man/man3c/timer_create.3c6
-rw-r--r--usr/src/man/man3c/timer_settime.3c11
-rw-r--r--usr/src/man/man3scf/Makefile51
-rw-r--r--usr/src/man/man3scf/smf_enable_instance.3scf44
6 files changed, 71 insertions, 87 deletions
diff --git a/usr/src/man/man1/svcs.1 b/usr/src/man/man1/svcs.1
index a7b9d1b5be..cb8b3cd120 100644
--- a/usr/src/man/man1/svcs.1
+++ b/usr/src/man/man1/svcs.1
@@ -1,13 +1,13 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
+.\" Copyright 2020 Joyent, Inc.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH SVCS 1 "Apr 17, 2011"
+.TH SVCS 1 "May 11, 2020"
.SH NAME
svcs \- report service status
.SH SYNOPSIS
-.LP
.nf
\fBsvcs\fR [\fB-aHpv?\fR] [\fB-Z\fR | \fB-z\fR \fIzone\fR] [\fB-o\fR \fIcol\fR[,\fIcol\fR]]... [\fB-R\fR \fIFMRI-instance\fR]...
[\fB-sS\fR \fIcol\fR]... [\fIFMRI\fR | \fIpattern\fR]...
@@ -30,8 +30,6 @@ svcs \- report service status
.fi
.SH DESCRIPTION
-.sp
-.LP
The \fBsvcs\fR command displays information about service instances as recorded
in the service configuration repository.
.sp
@@ -62,8 +60,6 @@ Error messages are printed to the standard error stream.
The output of this command can be used appropriately as input to the
\fBsvcadm\fR(1M) command.
.SH OPTIONS
-.sp
-.LP
The following options are supported:
.sp
.ne 2
@@ -212,6 +208,10 @@ temporarily (until the next system reboot). The former is specified as either
A service might be temporarily disabled because an administrator has run
\fBsvcadm disable -t\fR, used \fBsvcadm milestone\fR, or booted the system to a
specific milestone. See \fBsvcadm\fR(1M) for details.
+.sp
+If a service instance was disabled via
+\fBsvcadm disable -c\fR
+, then the provided comment will also be displayed.
.RE
.RE
@@ -337,8 +337,6 @@ zone, see \fBzones\fR(5).
.RE
.SH OPERANDS
-.sp
-.LP
The following operands are supported:
.sp
.ne 2
@@ -421,8 +419,6 @@ An FMRI that specifies an instance.
.RE
.SH COLUMNS
-.sp
-.LP
Column names are case insensitive. The default output format is equivalent to
"\fB-o\fR \fBstate,stime,fmri\fR". The default sorting columns are \fBSTATE\fR,
\fBSTIME\fR, \fBFMRI\fR.
@@ -607,7 +603,6 @@ blanks.
.RE
.SH EXAMPLES
-.LP
\fBExample 1 \fRDisplaying the Default Output
.sp
.LP
@@ -767,8 +762,6 @@ Impact: This service is not running.
.sp
.SH EXIT STATUS
-.sp
-.LP
The following exit values are returned:
.sp
.ne 2
@@ -798,8 +791,6 @@ Invalid command line options were specified.
.RE
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -817,8 +808,6 @@ Interface Stability See below.
.LP
Screen output is Uncommitted. The invocation is Committed.
.SH SEE ALSO
-.sp
-.LP
\fBps\fR(1), \fBsvcprop\fR(1), \fBsvcadm\fR(1M), \fBsvccfg\fR(1M),
\fBsvc.startd\fR(1M), \fBstat\fR(2), \fBlibscf\fR(3LIB), \fBattributes\fR(5),
\fBfnmatch\fR(5), \fBsmf\fR(5), \fBzones\fR(5)
diff --git a/usr/src/man/man1m/svcadm.1m b/usr/src/man/man1m/svcadm.1m
index 4bfefe5eb3..550e093239 100644
--- a/usr/src/man/man1m/svcadm.1m
+++ b/usr/src/man/man1m/svcadm.1m
@@ -1,10 +1,10 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
-.\" Copyright 2019 Joyent, Inc.
+.\" Copyright 2020 Joyent, Inc.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH SVCADM 1M "Oct 24, 2019"
+.TH SVCADM 1M "May 11, 2020"
.SH NAME
svcadm \- manipulate service instances
.SH SYNOPSIS
@@ -15,8 +15,8 @@ svcadm \- manipulate service instances
.LP
.nf
-\fB/usr/sbin/svcadm\fR [\fB-S state\fR] [\fB-v\fR] [\fB-Z\fR | \fB-z\fR \fIzone\fR] disable [\fB-st\fR]
- [{\fIFMRI\fR | \fIpattern\fR}...]
+\fB/usr/sbin/svcadm\fR [\fB-S state\fR] [\fB-v\fR] [\fB-Z\fR | \fB-z\fR \fIzone\fR] disable
+ [\fB-c\fR \fIcomment\fR] [\fB-st\fR] [{\fIFMRI\fR | \fIpattern\fR}...]
.fi
.LP
@@ -142,7 +142,7 @@ persistent across reboot.
.sp
.ne 2
.na
-\fB\fBdisable\fR [\fB-st\fR] {\fIFMRI\fR | \fIpattern\fR}...\fR
+\fB\fBdisable\fR [\fB-c\fR \fIcomment\fR] [\fB-st\fR] {\fIFMRI\fR | \fIpattern\fR}...\fR
.ad
.sp .6
.RS 4n
@@ -161,6 +161,11 @@ service instance. Temporary disable only lasts until reboot. This action
requires permission to modify the "restarter_actions" property group of the
service instance (see \fBsmf_security\fR(5)). By default, \fBdisable\fR is
persistent across reboot.
+.sp
+If the \fB-c\fR option is specified, the given free-form comment is recorded
+in the (temporary) service configuration under the \fBgeneral/comment\fR
+property. This can serve as an administrator reason for disabling the service,
+and is reported by \fBsvcs\fR(1).
.RE
.sp
@@ -379,16 +384,16 @@ However, you can abbreviate the full \fIFMRI\fR as follows:
.sp
.LP
-\fBExample 2 \fRDisabling the Standard HTTP Server
+\fBExample 2 \fRDisabling a service
.sp
.LP
-The following command disables the standard HTTP server, using an abbreviated
-\fIFMRI\fR:
+The following command synchronously disables a service, using an abbreviated
+\fIFMRI\fR, and recording a ticket ID as the administrative reason:
.sp
.in +2
.nf
-$ svcadm disable http
+$ svcadm disable -c "OPS-1000" -s http
.fi
.in -2
.sp
diff --git a/usr/src/man/man3c/timer_create.3c b/usr/src/man/man3c/timer_create.3c
index 08b8351755..63b57e0a41 100644
--- a/usr/src/man/man3c/timer_create.3c
+++ b/usr/src/man/man3c/timer_create.3c
@@ -48,7 +48,6 @@
.SH NAME
timer_create \- create a timer
.SH SYNOPSIS
-.LP
.nf
#include <signal.h>
#include <time.h>
@@ -58,7 +57,6 @@ timer_create \- create a timer
.fi
.SH DESCRIPTION
-.LP
The \fBtimer_create()\fR function creates a timer using the specified clock,
\fIclock_id\fR, as the timing base. The \fBtimer_create()\fR function returns,
in the location referenced by \fItimerid\fR, a timer \fBID\fR of type
@@ -131,14 +129,12 @@ Timers are not inherited by a child process across a \fBfork\fR(2) and are
disarmed and deleted by a call to one of the \fBexec\fR functions (see
\fBexec\fR(2)).
.SH RETURN VALUES
-.LP
Upon successful completion, \fBtimer_create()\fR returns \fB0\fR and updates
the location referenced by \fItimerid\fR to a \fBtimer_t\fR, which can be
passed to the per-process timer calls. If an error occurs, the function returns
\fB\(mi1\fR and sets \fBerrno\fR to indicate the error. The value of
\fItimerid\fR is undefined if an error occurs.
.SH ERRORS
-.LP
The \fBtimer_create()\fR function will fail if:
.sp
.ne 2
@@ -161,7 +157,6 @@ The specified clock \fBID\fR, \fIclock_id\fR, is not defined.
.RE
.SH ATTRIBUTES
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -180,7 +175,6 @@ Standard See \fBstandards\fR(5).
.TE
.SH SEE ALSO
-.LP
\fBexec\fR(2), \fBfork\fR(2), \fBtime\fR(2), \fBclock_settime\fR(3C),
\fBsignal\fR(3C), \fBsignal.h\fR(3HEAD), \fBtimer_delete\fR(3C),
\fBtimer_settime\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
diff --git a/usr/src/man/man3c/timer_settime.3c b/usr/src/man/man3c/timer_settime.3c
index ca07bfdb63..3813a9d86d 100644
--- a/usr/src/man/man3c/timer_settime.3c
+++ b/usr/src/man/man3c/timer_settime.3c
@@ -49,7 +49,6 @@
.SH NAME
timer_settime, timer_gettime, timer_getoverrun \- per-process timers
.SH SYNOPSIS
-.LP
.nf
#include <time.h>
@@ -69,8 +68,6 @@ timer_settime, timer_gettime, timer_getoverrun \- per-process timers
.fi
.SH DESCRIPTION
-.sp
-.LP
The \fBtimer_settime()\fR function sets the time until the next expiration of
the timer specified by \fItimerid\fR from the \fBit_value\fR member of the
\fIvalue\fR argument and arm the timer if the \fBit_value\fR member of
@@ -146,16 +143,12 @@ smaller than a system defined threshold, then {\fBPRIV_PROC_CLOCK_HIGHRES\fR}
must be asserted in the effective set of the calling process or the time values
will be adjusted up to the threshold value.
.SH RETURN VALUES
-.sp
-.LP
If the \fBtimer_settime()\fR or \fBtimer_gettime()\fR functions succeed,
\fB0\fR is returned. If an error occurs for either of these functions,
\fB\(mi1\fR is returned, and \fBerrno\fR is set to indicate the error. If the
\fBtimer_getoverrun()\fR function succeeds, it returns the timer expiration
overrun count as explained above.
.SH ERRORS
-.sp
-.LP
The \fBtimer_settime()\fR, \fBtimer_gettime()\fR and \fBtimer_getoverrun()\fR
functions will fail if:
.sp
@@ -190,8 +183,6 @@ than or equal to 1000 million.
.RE
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -210,8 +201,6 @@ Standard See \fBstandards\fR(5).
.TE
.SH SEE ALSO
-.sp
-.LP
\fBtime.h\fR(3HEAD), \fBclock_settime\fR(3C), \fBtimer_create\fR(3C),
\fBtimer_delete\fR(3C), \fBattributes\fR(5), \fBprivileges\fR(5),
\fBstandards\fR(5)
diff --git a/usr/src/man/man3scf/Makefile b/usr/src/man/man3scf/Makefile
index 088037ad15..cbebef7221 100644
--- a/usr/src/man/man3scf/Makefile
+++ b/usr/src/man/man3scf/Makefile
@@ -12,35 +12,36 @@
#
# Copyright 2011, Richard Lowe
# Copyright 2013 Nexenta Systems, Inc. All rights reserved.
+# Copyright 2020 Joyent, Inc.
#
include $(SRC)/Makefile.master
-MANSECT= 3scf
+MANSECT= 3scf
-MANFILES= scf_entry_create.3scf \
- scf_error.3scf \
- scf_handle_create.3scf \
- scf_handle_decode_fmri.3scf \
- scf_instance_create.3scf \
- scf_iter_create.3scf \
- scf_limit.3scf \
- scf_pg_create.3scf \
- scf_property_create.3scf \
- scf_scope_create.3scf \
- scf_service_create.3scf \
- scf_simple_prop_get.3scf \
- scf_simple_walk_instances.3scf \
- scf_snaplevel_create.3scf \
- scf_snapshot_create.3scf \
- scf_tmpl_pg_create.3scf \
- scf_tmpl_pg_name.3scf \
- scf_tmpl_prop_create.3scf \
- scf_tmpl_prop_name.3scf \
- scf_tmpl_validate_fmri.3scf \
- scf_transaction_create.3scf \
- scf_value_create.3scf \
- smf_enable_instance.3scf
+MANFILES= scf_entry_create.3scf \
+ scf_error.3scf \
+ scf_handle_create.3scf \
+ scf_handle_decode_fmri.3scf \
+ scf_instance_create.3scf \
+ scf_iter_create.3scf \
+ scf_limit.3scf \
+ scf_pg_create.3scf \
+ scf_property_create.3scf \
+ scf_scope_create.3scf \
+ scf_service_create.3scf \
+ scf_simple_prop_get.3scf \
+ scf_simple_walk_instances.3scf \
+ scf_snaplevel_create.3scf \
+ scf_snapshot_create.3scf \
+ scf_tmpl_pg_create.3scf \
+ scf_tmpl_pg_name.3scf \
+ scf_tmpl_prop_create.3scf \
+ scf_tmpl_prop_name.3scf \
+ scf_tmpl_validate_fmri.3scf \
+ scf_transaction_create.3scf \
+ scf_value_create.3scf \
+ smf_enable_instance.3scf
MANLINKS= scf_count_ranges_destroy.3scf \
@@ -241,6 +242,7 @@ MANLINKS= scf_count_ranges_destroy.3scf \
scf_values_destroy.3scf \
smf_degrade_instance.3scf \
smf_disable_instance.3scf \
+ smf_disable_instance_with_comment.3scf \
smf_get_state.3scf \
smf_maintain_instance.3scf \
smf_refresh_instance.3scf \
@@ -465,6 +467,7 @@ scf_value_type.3scf := LINKSRC = scf_value_create.3scf
smf_degrade_instance.3scf := LINKSRC = smf_enable_instance.3scf
smf_disable_instance.3scf := LINKSRC = smf_enable_instance.3scf
+smf_disable_instance_with_comment.3scf := LINKSRC = smf_enable_instance.3scf
smf_get_state.3scf := LINKSRC = smf_enable_instance.3scf
smf_maintain_instance.3scf := LINKSRC = smf_enable_instance.3scf
smf_refresh_instance.3scf := LINKSRC = smf_enable_instance.3scf
diff --git a/usr/src/man/man3scf/smf_enable_instance.3scf b/usr/src/man/man3scf/smf_enable_instance.3scf
index 6e8663f77f..9333b16265 100644
--- a/usr/src/man/man3scf/smf_enable_instance.3scf
+++ b/usr/src/man/man3scf/smf_enable_instance.3scf
@@ -1,16 +1,16 @@
'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
+.\" Copyright 2020 Joyent, Inc.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH SMF_ENABLE_INSTANCE 3SCF "Nov 5, 2007"
+.TH SMF_ENABLE_INSTANCE 3SCF "May 15, 2020"
.SH NAME
-smf_enable_instance, smf_disable_instance, smf_refresh_instance,
-smf_restart_instance, smf_maintain_instance, smf_degrade_instance,
-smf_restore_instance, smf_get_state \- administrative interface to the Service
-Configuration Facility
+smf_enable_instance, smf_disable_instance, smf_disable_instance_with_comment,
+smf_refresh_instance, smf_restart_instance, smf_maintain_instance,
+smf_degrade_instance, smf_restore_instance, smf_get_state \-
+administrative interface to the Service Configuration Facility
.SH SYNOPSIS
-.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <libscf.h>
@@ -25,6 +25,12 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.
.LP
.nf
+\fBint\fR \fBsmf_disable_instance_with_comment\fR(\fBconst char *\fR\fIinstance\fR,
+ \fBint\fR \fIflags\fR, \fBconst char *\fR\fIcomment\fR);
+.fi
+
+.LP
+.nf
\fBint\fR \fBsmf_refresh_instance\fR(\fBconst char *\fR\fIinstance\fR);
.fi
@@ -54,8 +60,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.
.fi
.SH DESCRIPTION
-.sp
-.LP
These functions provide administrative control over service instances. Using
these functions, an administrative tool can make a request to enable, disable,
refresh, or restart an instance. All calls are asynchronous. They request an
@@ -77,6 +81,13 @@ the current system instance. The \fIflags\fR argument is set to \fB0\fR if no
flags are to be use.
.sp
.LP
+The \fBsmf_disable_instance_with_comment()\fR function behaves the same as
+\fBsmf_disable_instance()\fR, except the given free-form comment is recorded
+under the \fIcomment\fR property, as reported by \fBsvcs\fR(1).
+The comment may be up to \fBSCF_COMMENT_MAX_LENGTH\fR characters including
+the NUL terminator.
+.sp
+.LP
The \fBsmf_refresh_instance()\fR function causes the service instance specified
by \fIinstance\fR FMRI to re-read its configuration information.
.sp
@@ -123,20 +134,17 @@ string. Possible state strings are defined as the following:
.in -2
.SH RETURN VALUES
-.sp
-.LP
Upon successful completion, \fBsmf_enable_instance()\fR,
-\fBsmf_disable_instance()\fR, \fBsmf_refresh_instance()\fR,
-\fBsmf_restart_instance()\fR, \fBsmf_maintain_instance()\fR,
-\fBsmf_degrade_instance()\fR, and \fBsmf_restore_instance()\fR return \fB0\fR.
+\fBsmf_disable_instance()\fR, \fBsmf_disable_instance_with_comment()\fR,
+\fBsmf_refresh_instance()\fR, \fBsmf_restart_instance()\fR,
+\fBsmf_maintain_instance()\fR, \fBsmf_degrade_instance()\fR,
+and \fBsmf_restore_instance()\fR return \fB0\fR.
Otherwise, they return \fB-1\fR\&.
.sp
.LP
Upon successful completion, smf_get_state returns an allocated string.
Otherwise, it returns \fINULL\fR.
.SH ERRORS
-.sp
-.LP
These functions will fail if:
.sp
.ne 2
@@ -241,8 +249,6 @@ The function is called on an instance in an inappropriate state.
.LP
The \fBscf_error\fR(3SCF) function can be used to retrieve the error value.
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -259,7 +265,5 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.sp
-.LP
\fBsvc.startd\fR(1M), \fBlibscf\fR(3LIB), \fBscf_error\fR(3SCF),
-\fBattributes\fR(5), \fBsmf_security\fR(5)
+\fBattributes\fR(5), \fBsmf_security\fR(5), \fBsvcs\fR(1)