# HG changeset patch # User Rich Burridge # Date 1445635364 25200 # Node ID 634e69f7ae42a35e77799237292357c701388f26 # Parent 2883c86b26b8f4d0e3067292fb8d39073f721c1a PSARC 2015/428 Normalization of Solaris man page section numbers 22067958 Normalize memcached man pages 22071765 Normalize apache24 man pages 22071942 Normalize sudo man pages 22072168 Normalize graphviz man pages 22072387 Normalize quagga man pages diff -r 2883c86b26b8 -r 634e69f7ae42 components/apache24/Solaris/apache24.1m.sunman --- a/components/apache24/Solaris/apache24.1m.sunman Fri Oct 23 05:42:31 2015 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,416 +0,0 @@ -'\" te -.\" Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved. -.TH apache24 1M "Jan 2015" "SunOS 5.12" "System Administration Commands" -.SH NAME -apache2 \- Apache HTTP Server Version 2.4 overview -.SH SYNOPSIS -.LP -.nf -\fBapache2\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Apache HTTP Server Version 2.4 (Apache 2) consists of a main server daemon, -loadable server modules, some additional support utilities, configuration -files, and documentation. -.sp -.LP -Note Apache 2.4 is 64-bit only and Apache 2.2 modules are not -binary compatible with 2.4. -.sp -Several Apache 2 modules are bundled in separate packages to reduce number of -dependencies of main package. These are: -.sp -.in +2 -.nf -web/server/apache-24/apache-dbd -web/server/apache-24/apache-ldap -web/server/apache-24/apache-lua -web/server/apache-24/apache-ssl -web/server/apache-24/apache-ssl-fips-140 -.fi -.in -2 -.sp -Apache 2 can be enabled by authorized user within the service -management facility (SMF), using the following fault management -resource identifier (FMRI): -.sp -.in +2 -.nf -svc:/network/http:apache24 -.fi -.in -2 -.sp -Available SMF properties are listed in the following table: -.sp -.TS -tab(^G) allbox; -cw(2.750000i)| cw(2.750000i) -lw(2.750000i)| lw(2.750000i). -SMF Property Name Value -httpd/MPM event (default), prefork or worker -httpd/startup_options valid apachectl options -.TE -.SH FILES -.sp -.LP -The following files specify the installation locations for Apache 2: -.LP -Note : -.RS +4 -.TP -.ie t \(bu -.el o -The string \fB[version]\fR should be expanded -to \fB"MAJOR.MINOR"\fR. For example, \fB/usr/apache2/2.4/*\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -To find the current version of Apache 2 installed on your -machine, type the following command: -.sp -.in +2 -.nf -$ /usr/apache2/[version]/bin/apachectl -v -.fi -.in -2 -.sp - -.RE -.RE -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/\fR\fR -.ad -.sp .6 -.RS 4n -Contains server configuration files. A newly-installed server -contains a default \fBhttpd.conf\fR file. This is the main configuration file. -.sp -If there is need to use different main configuration file (e.g. to run -multiple Apache 2 instances), it's possible by providing Apache '-f' -option via SMF property httpd/startup_options. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/conf.d/\fR\fR -.ad -.sp .6 -.RS 4n -Contains additional server configuration files. -.sp -By default, server will load all the \fB\&.conf\fR files -placed under this directory. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/envvars\fR\fR -.ad -.sp .6 -.RS 4n -File for specifying the environment settings which the server uses at -startup. This is the user-editable version of the -/usr/apache2/[version]/bin/envvars file. -.sp -Note that this is default path to envvars file only in case where main -configuration file is in directory /etc/apache2/[version]/. If this -is not the case Apache 2 will look for envvars file in the same -directory where is main configuration file. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/magic\fR\fR -.ad -.sp .6 -.RS 4n -Magic data for \fBmod_mime_magic\fR Apache module as documented in the -.nf -\fB/usr/apache2/2.2/manual/mod/mod_mime_magic.html\fR file. -.fi -.nf -Editing this file is not recommended. -.fi -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/mime.types\fR\fR -.ad -.sp .6 -.RS 4n -Default MIME types file. This file sets the default list of -mappings from filename extensions to content types, changing this file is -not recommended. Use the \fBAddType\fR directive instead. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/original/\fR\fR -.ad -.sp .6 -.RS 4n -Contents under this directory are delivered as-is from the -apache distribution and these files are not meant to be read by the server. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/etc/apache2/[version]/sample-conf.d/\fR\fR -.ad -.sp .6 -.RS 4n -Contains sample \fB\&.conf\fR files. These are -not included in the main configuration file. To use the sample file, copy -the file to \fBconf.d\fR directory and modify as per the need. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/apache2/[version]/bin/\fR\fR -.ad -.sp .6 -.RS 4n -Contains the main httpd executable as well as other utility programs. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/apache2/[version]/bin/envvars\fR\fR -.ad -.sp .6 -.RS 4n -Contains the default environment settings that the server uses at startup. -.nf -Editing this file is not recommended. -.fi -Instead, user should use /etc/apache2/[version]/envvars file. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/apache2/[version]/manual/\fR\fR -.ad -.sp .6 -.RS 4n -Contains the Apache 2 manual in HTML format. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/apache2/[version]/include/\fR\fR -.ad -.sp .6 -.RS 4n -Contains the Apache 2 header files, which are needed for building -various optional server extensions with \fBapxs(8)\fR. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/apache2/[version]/libexec/\fR\fR -.ad -.sp .6 -.RS 4n -Contains loadable modules (DSOs) supplied with the server. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/apache2/[version]/man/\fR\fR -.ad -.sp .6 -.RS 4n -Contains man pages for the server, utility programs, and \fBmod_perl\fR. -.sp -Add this directory to your MANPATH to read the Apache 2 man pages. See -Notes. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/var/apache2/[version]/cgi-bin/\fR\fR -.ad -.sp .6 -.RS 4n -Default location for the CGI scripts. -.sp -This can be changed by altering the \fBhttpd.conf\fR file -and restarting the server. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/var/apache2/[version]/htdocs/\fR\fR -.ad -.sp .6 -.RS 4n -Default document root. -.sp -This can be changed by altering the \fBhttpd.conf\fR file -and restarting the server. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/var/apache2/[version]/icons/\fR\fR -.ad -.sp .6 -.RS 4n -Icons used by the server. -.sp -This should not be changed. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/var/apache2/[version]/libexec/\fR\fR -.ad -.sp .6 -.RS 4n -Place holder for user Apache 2 modules. -.sp -Any modules which are added using \fBapxs(8)\fR are copied into this directory. -.RE - -.sp -.ne 2 -.mk -.na -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/var/apache2/[version]/logs/\fR\fR -.ad -.sp .6 -.RS 4n -Contains server log files. -.sp -The formats, names, and locations of the files in this directory can -be altered by various configuration directives in the \fBhttpd.conf\fR file. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/var/apache2/[version]/proxy/\fR\fR -.ad -.sp .6 -.RS 4n -Directory used to cache pages if the caching feature of \fBmod_proxy\fR is enabled in the \fBhttpd.conf\fR file. -.sp -The location of the cache can also be changed by changing the proxy -configuration in the \fBhttpd.conf\fR file. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB/usr/bin/\fR\fR -.ad -.sp .6 -.RS 4na -Contains pkg(5) version based mediated symbolic links to the various -Apache 2 utility programs. -.RE - - -.SH EXAMPLES -.LP -\fBExample 1 \fRTo switch to worker MPM type -.sp - -.in +2 -.nf -# \fBsvccfg -s apache24 setprop httpd/MPM=worker\fR -# \fBsvcadm refresh apache24\fR -# \fBsvcadm restart apache24\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRCreate new SMF apache instance -.sp -.LP -This expects that valid configuration exists in -/var/myapache/httpd.conf and it has altered all relevant directives -against default apache instance (e.g. PidFile, Listen, DocumentRoot, -ErrorLog and CustomLog). -.sp -.in +2 -.nf -# \fBcp /lib/svc/manifest/network/http-apache24.xml my-apache24.xml\fR -.sp -Edit my-apache24.xml and rename instance name to my-apache24. - -# \fBsvccfg import my-apache24.xml\fR -# \fBsvccfg -s my-apache24 setprop httpd/startup_options=\\("-f" "/var/myapache/httpd.conf"\\)\fR -# \fBsvcadm refresh my-apache24\fR -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBattributes(5)\fR, \fBhttpd(8)\fR, apachectl(8) -.sp -.LP -http://httpd.apache.org/docs/ -.SH NOTES -.sp -.LP -In addition to the documentation and man pages included with Solaris, -more information is available at http://httpd.apache.org/\&. -.sp -.LP -The Apache 2 man pages are provided with the programming modules. To -view the manual pages for the Apache 2 modules with the man command, add \fB/usr/apache2/[version]/man\fR to the MANPATH environment variable. -See \fBman(1)\fR for more information. Running \fBcatman(1M)\fR on -the Apache 2 manual pages is not supported. diff -r 2883c86b26b8 -r 634e69f7ae42 components/apache24/Solaris/apache24.8.sunman --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/components/apache24/Solaris/apache24.8.sunman Fri Oct 23 14:22:44 2015 -0700 @@ -0,0 +1,416 @@ +'\" te +.\" Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved. +.TH apache24 8 "20 Oct 2015" "SunOS 5.12" "System Administration Commands" +.SH NAME +apache2 \- Apache HTTP Server Version 2.4 overview +.SH SYNOPSIS +.LP +.nf +\fBapache2\fR +.fi + +.SH DESCRIPTION +.sp +.LP +Apache HTTP Server Version 2.4 (Apache 2) consists of a main server daemon, +loadable server modules, some additional support utilities, configuration +files, and documentation. +.sp +.LP +Note Apache 2.4 is 64-bit only and Apache 2.2 modules are not +binary compatible with 2.4. +.sp +Several Apache 2 modules are bundled in separate packages to reduce number of +dependencies of main package. These are: +.sp +.in +2 +.nf +web/server/apache-24/apache-dbd +web/server/apache-24/apache-ldap +web/server/apache-24/apache-lua +web/server/apache-24/apache-ssl +web/server/apache-24/apache-ssl-fips-140 +.fi +.in -2 +.sp +Apache 2 can be enabled by authorized user within the service +management facility (SMF), using the following fault management +resource identifier (FMRI): +.sp +.in +2 +.nf +svc:/network/http:apache24 +.fi +.in -2 +.sp +Available SMF properties are listed in the following table: +.sp +.TS +tab(^G) allbox; +cw(2.750000i)| cw(2.750000i) +lw(2.750000i)| lw(2.750000i). +SMF Property Name Value +httpd/MPM event (default), prefork or worker +httpd/startup_options valid apachectl options +.TE +.SH FILES +.sp +.LP +The following files specify the installation locations for Apache 2: +.LP +Note : +.RS +4 +.TP +.ie t \(bu +.el o +The string \fB[version]\fR should be expanded +to \fB"MAJOR.MINOR"\fR. For example, \fB/usr/apache2/2.4/*\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +To find the current version of Apache 2 installed on your +machine, type the following command: +.sp +.in +2 +.nf +$ /usr/apache2/[version]/bin/apachectl -v +.fi +.in -2 +.sp + +.RE +.RE +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/\fR\fR +.ad +.sp .6 +.RS 4n +Contains server configuration files. A newly-installed server +contains a default \fBhttpd.conf\fR file. This is the main configuration file. +.sp +If there is need to use different main configuration file (e.g. to run +multiple Apache 2 instances), it's possible by providing Apache '-f' +option via SMF property httpd/startup_options. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/conf.d/\fR\fR +.ad +.sp .6 +.RS 4n +Contains additional server configuration files. +.sp +By default, server will load all the \fB\&.conf\fR files +placed under this directory. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/envvars\fR\fR +.ad +.sp .6 +.RS 4n +File for specifying the environment settings which the server uses at +startup. This is the user-editable version of the +/usr/apache2/[version]/bin/envvars file. +.sp +Note that this is default path to envvars file only in case where main +configuration file is in directory /etc/apache2/[version]/. If this +is not the case Apache 2 will look for envvars file in the same +directory where is main configuration file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/magic\fR\fR +.ad +.sp .6 +.RS 4n +Magic data for \fBmod_mime_magic\fR Apache module as documented in the +.nf +\fB/usr/apache2/2.2/manual/mod/mod_mime_magic.html\fR file. +.fi +.nf +Editing this file is not recommended. +.fi +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/mime.types\fR\fR +.ad +.sp .6 +.RS 4n +Default MIME types file. This file sets the default list of +mappings from filename extensions to content types, changing this file is +not recommended. Use the \fBAddType\fR directive instead. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/original/\fR\fR +.ad +.sp .6 +.RS 4n +Contents under this directory are delivered as-is from the +apache distribution and these files are not meant to be read by the server. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/etc/apache2/[version]/sample-conf.d/\fR\fR +.ad +.sp .6 +.RS 4n +Contains sample \fB\&.conf\fR files. These are +not included in the main configuration file. To use the sample file, copy +the file to \fBconf.d\fR directory and modify as per the need. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/apache2/[version]/bin/\fR\fR +.ad +.sp .6 +.RS 4n +Contains the main httpd executable as well as other utility programs. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/apache2/[version]/bin/envvars\fR\fR +.ad +.sp .6 +.RS 4n +Contains the default environment settings that the server uses at startup. +.nf +Editing this file is not recommended. +.fi +Instead, user should use /etc/apache2/[version]/envvars file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/apache2/[version]/manual/\fR\fR +.ad +.sp .6 +.RS 4n +Contains the Apache 2 manual in HTML format. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/apache2/[version]/include/\fR\fR +.ad +.sp .6 +.RS 4n +Contains the Apache 2 header files, which are needed for building +various optional server extensions with \fBapxs(1)\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/apache2/[version]/libexec/\fR\fR +.ad +.sp .6 +.RS 4n +Contains loadable modules (DSOs) supplied with the server. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/apache2/[version]/man/\fR\fR +.ad +.sp .6 +.RS 4n +Contains man pages for the server, utility programs, and \fBmod_perl\fR. +.sp +Add this directory to your MANPATH to read the Apache 2 man pages. See +Notes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/var/apache2/[version]/cgi-bin/\fR\fR +.ad +.sp .6 +.RS 4n +Default location for the CGI scripts. +.sp +This can be changed by altering the \fBhttpd.conf\fR file +and restarting the server. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/var/apache2/[version]/htdocs/\fR\fR +.ad +.sp .6 +.RS 4n +Default document root. +.sp +This can be changed by altering the \fBhttpd.conf\fR file +and restarting the server. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/var/apache2/[version]/icons/\fR\fR +.ad +.sp .6 +.RS 4n +Icons used by the server. +.sp +This should not be changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/var/apache2/[version]/libexec/\fR\fR +.ad +.sp .6 +.RS 4n +Place holder for user Apache 2 modules. +.sp +Any modules which are added using \fBapxs(1)\fR are copied into this directory. +.RE + +.sp +.ne 2 +.mk +.na +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/var/apache2/[version]/logs/\fR\fR +.ad +.sp .6 +.RS 4n +Contains server log files. +.sp +The formats, names, and locations of the files in this directory can +be altered by various configuration directives in the \fBhttpd.conf\fR file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/var/apache2/[version]/proxy/\fR\fR +.ad +.sp .6 +.RS 4n +Directory used to cache pages if the caching feature of \fBmod_proxy\fR is enabled in the \fBhttpd.conf\fR file. +.sp +The location of the cache can also be changed by changing the proxy +configuration in the \fBhttpd.conf\fR file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/bin/\fR\fR +.ad +.sp .6 +.RS 4na +Contains pkg(5) version based mediated symbolic links to the various +Apache 2 utility programs. +.RE + + +.SH EXAMPLES +.LP +\fBExample 1 \fRTo switch to worker MPM type +.sp + +.in +2 +.nf +# \fBsvccfg -s apache24 setprop httpd/MPM=worker\fR +# \fBsvcadm refresh apache24\fR +# \fBsvcadm restart apache24\fR +.fi +.in -2 +.sp + +.LP +\fBExample 2 \fRCreate new SMF apache instance +.sp +.LP +This expects that valid configuration exists in +/var/myapache/httpd.conf and it has altered all relevant directives +against default apache instance (e.g. PidFile, Listen, DocumentRoot, +ErrorLog and CustomLog). +.sp +.in +2 +.nf +# \fBcp /lib/svc/manifest/network/http-apache24.xml my-apache24.xml\fR +.sp +Edit my-apache24.xml and rename instance name to my-apache24. + +# \fBsvccfg import my-apache24.xml\fR +# \fBsvccfg -s my-apache24 setprop httpd/startup_options=\\("-f" "/var/myapache/httpd.conf"\\)\fR +# \fBsvcadm refresh my-apache24\fR +.fi +.in -2 +.sp + +.SH SEE ALSO +.sp +.LP +\fBattributes(7)\fR, \fBhttpd(8)\fR, apachectl(8) +.sp +.LP +http://httpd.apache.org/docs/ +.SH NOTES +.sp +.LP +In addition to the documentation and man pages included with Solaris, +more information is available at http://httpd.apache.org/\&. +.sp +.LP +The Apache 2 man pages are provided with the programming modules. To +view the manual pages for the Apache 2 modules with the man command, add \fB/usr/apache2/[version]/man\fR to the MANPATH environment variable. +See \fBman(1)\fR for more information. Running \fBcatman(8)\fR on +the Apache 2 manual pages is not supported. diff -r 2883c86b26b8 -r 634e69f7ae42 components/apache24/apache-24.p5m --- a/components/apache24/apache-24.p5m Fri Oct 23 05:42:31 2015 -0700 +++ b/components/apache24/apache-24.p5m Fri Oct 23 14:22:44 2015 -0700 @@ -1441,9 +1441,9 @@ link path=usr/share/man/man1/logresolve.1 \ target=../../../apache2/2.4/man/man1/logresolve.1 mediator=apache \ mediator-version=2.4 -link path=usr/share/man/man1m/apache2.1m target=apache24.1m mediator=apache \ +link path=usr/share/man/man8/apache2.8 target=apache24.8 mediator=apache \ mediator-version=2.4 -file Solaris/apache24.1m.sunman path=usr/share/man/man1m/apache24.1m +file Solaris/apache24.8.sunman path=usr/share/man/man8/apache24.8 link path=usr/share/man/man8/apachectl.8 \ target=../../../apache2/2.4/man/man8/apachectl.8 mediator=apache \ mediator-version=2.4 diff -r 2883c86b26b8 -r 634e69f7ae42 components/graphviz/graphviz.p5m --- a/components/graphviz/graphviz.p5m Fri Oct 23 05:42:31 2015 -0700 +++ b/components/graphviz/graphviz.p5m Fri Oct 23 14:22:44 2015 -0700 @@ -506,7 +506,7 @@ file path=usr/share/man/man3/pack.3 file path=usr/share/man/man3/pathplan.3 file path=usr/share/man/man3/xdot.3 -file usr/share/man/man7/graphviz.7 path=usr/share/man/man5/graphviz.5 +file path=usr/share/man/man7/graphviz.7 license COPYING license=EPL1.0 license graphviz.license.extra license="Other Notices" diff -r 2883c86b26b8 -r 634e69f7ae42 components/memcached/Solaris/memcached.1m --- a/components/memcached/Solaris/memcached.1m Fri Oct 23 05:42:31 2015 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,487 +0,0 @@ -'\" te -.TH memcached 1M "March 2008" "SunOS 5.11" "Administration Commands" -.SH NAME -memcached \- high performance memory object caching -system -.SH SYNOPSIS -.LP -.nf -\fBmemcached [\fB-l\fR \fI\fR] [\fB-d\fR] [\fB-u\fR \fI\fR] -[\fB-m\fR \fI\fR] [\fB-c\fR \fI\fR] [\fB-k\fR] [\fB-L \fR] -[\fB-p\fR \fI\fR] [\fB-U\fR \fI\fR] [\fB-s\fR \fI\fR] -[\fB-a\fR \fI\fR] [\fB-M\fR] [\fB-r\fR] [\fB-b\fR] -[\fB-f\fR \fI\fR] [\fB-n\fR \fI\fR] [\fB-h\fR] [\fB-v\fR] [\fB-vv\fR] [\fB-i\fR] -[\fB-P\fR \fI\fR] [\fB-t\fR \fI\fR] [\fB-D\fR \fI\fR]\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fBmemcached\fR is a flexible memory object caching daemon -designed to alleviate database load in dynamic web applications by storing -objects in memory. It is based on \fBlibevent\fR to scale to -any size needed, and is specifically optimized to avoid swapping and always -use non-blocking I/O. This man page documents briefly the \fBmemcached\fR memory -object caching daemon. -.SH OPTIONS -.sp -.LP -The options supported by the \fBmemcached\fR command are -described below. -.sp -.ne 2 -.mk -.na -\fB\fB-l\fR \fI\fR\fR -.ad -.RS 17n -.rt -Listen on \fI\fR; default -to \fBINADDR_ANY\fR. This is an important option to consider -as there is no other way to secure the installation. Binding to an internal -or fire walled network interface is suggested. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-d\fR\fR -.ad -.RS 17n -.rt -Run memcached as a daemon. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-u\fR \fI\fR\fR -.ad -.RS 17n -.rt -Assume the identity of \fI\fR only when run as a super user (root). -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-m\fR \fI\fR\fR -.ad -.RS 17n -.rt -Use the maximum \fI\fR MB memory for object storage; the default is 64 MB. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-c\fR \fI\fR\fR -.ad -.RS 17n -.rt -Use the specified number of maximum simultaneous connections; -the default is 1024. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-k\fR\fR -.ad -.RS 17n -.rt -Lock down all paged memory. -.sp -Use this option with caution with large caches. For information about -the configuration suggestions, see the README and the memcached home page. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-L\fR\fR -.ad -.RS 17n -.rt -Preallocate memory and use large memory pages if possible. -.sp -This option will preallocate cache memory for object storage. -See description of \fB-m\fR option for a specification of the size of the memory. -If supported by the platform, large memory pages will be allocated. -This should reduce number of TLB misses and increase performance. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-p\fR \fI\fR\fR -.ad -.RS 17n -.rt -Listen on the TCP port \fI\fR\&. -The default port is 11211. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-U\fR \fI\fR\fR -.ad -.RS 17n -.rt -Listen on the UDP port \fI\fR\&. -The default is 0, meaning that the UDP protocol is disabled. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-s\fR \fI\fR\fR -.ad -.RS 17n -.rt -Unix socket path to listen on (disables listening support for TCP and UDP). -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-a\fR \fI\fR\fR -.ad -.RS 17n -.rt -Permissions (in octal format) for Unix socket created with \fB-s\fR option. -Default value is 0700. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-M\fR\fR -.ad -.RS 17n -.rt -Disable automatic removal of items from the cache when out -of memory. Additions will not be possible until adequate space is freed up. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-r\fR\fR -.ad -.RS 17n -.rt -Raise the core file size limit to the maximum allowable. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-b\fR\fR -.ad -.RS 17n -.rt -Run a managed instance. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-f\fR \fI\fR\fR -.ad -.RS 17n -.rt -Use this option to specify \fI\fR as -the multiplier for computing the sizes of memory chunks that items are stored -in. A lower value may result in less wasted memory depending on the total -amount of memory available and the distribution of item sizes. The default -value is 1.25. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-n\fR \fI\fR\fR -.ad -.RS 17n -.rt -Allocate a minimum of \fI\fR bytes -for the item key, value, and flags. The default value is 48. If you have a -lot of small keys and values, you can get a significant memory efficiency -gain with a lower value. If you use a high chunk growth factor, that is \fB-f\fR option, you may want to increase the size to allow a bigger percentage -of your items to fit in the most densely packed smallest chunks. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-h\fR\fR -.ad -.RS 17n -.rt -Show the version of memcached and a summary of options. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-v\fR\fR -.ad -.RS 17n -.rt -Be verbose during the event loop; print out errors and warnings. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-vv\fR\fR -.ad -.RS 17n -.rt -Be even more verbose; same as \fB-v\fR option but -also print client commands and responses. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-i\fR\fR -.ad -.RS 17n -.rt -Display \fBmemcached\fR and \fBlibevent\fR licenses. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-P\fR \fI\fR\fR -.ad -.RS 17n -.rt -Print \fBpidfile\fR to the specified file. -.LP -Note - -.sp -.RS 2 -This option can be used only when \fBmechached\fR is -run as a daemon (\fB-d\fR option). -.RE -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-t\fR \fI\fR\fR -.ad -.RS 17n -.rt -Number of threads to use to process incoming requests. The default is 4. -It is typically not useful to set this much higher than the number of CPU cores -on the \fBmemcached\fR server. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-D\fR \fI\fR\fR -.ad -.RS 17n -.rt -Use the \fI\fR as the delimiter -between key prefixes and IDs. This is used for per-prefix statistics reporting. -The default is \fB:\fR (colon). If this option is specified, -statistics collection is turned on automatically; if not, then it can be turned -on by sending the \fBstats detail on\fR command to the server. -.RE - -.SH EXIT STATUS -.sp -.LP -The following exit values are returned: -.sp -.ne 2 -.mk -.na -\fB\fB0\fR\fR -.ad -.RS 5n -.rt -command executed successfully -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB1\fR\fR -.ad -.RS 5n -.rt -error in executing the command -.RE - -.SH SERVICE MANAGEMENT FACILITY -.sp -.LP -\fBmemcached\fR package for Solaris (\fBservice/memcached\fR) -includes files necessary to register with the Service Management Facility -described in \fISMF(5)\fR. The following procedure describes the steps to automate -the service management using memcached. -.RS +4 -.TP -1. -Add other parameters to be passed to the memcached service instance. -.sp -example: specify the server to use 1024 MB of memory -.sp -.in +2 -.nf -example% svccfg -svc:> select memcached -svc:/application/database/memcached> setprop memcached/options=("-m" "1024") -svc:/application/database/memcached> quit -example% svcadm refresh memcached -.fi -.in -2 - -.LP -Note - -.sp -.RS 2 -The arguments cannot be passed as a single string because of a limitation in \fIsvccfg\fR. -.RE -.RE -.RS +4 -.TP -2. -Enable memcached . -.sp -.in +2 -.nf -example% svcadm enable memcached -.fi -.in -2 - -The state of the service instance changes to \fBonline\fR, -and the memcached service instance must be started: -.sp -.in +2 -.nf -example% svcs memcached -STATE STIME FMRI -online 1:19:15 svc:/application/database/memcached:default -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -3. -To disable shutdown and automatic restart of memcached service instance, -.sp -.in +2 -.nf -example% svcadm disable memcached -.fi -.in -2 - -.RE -.SH USER AUTHORIZATIONS -.sp -.LP -You can use \fBRBAC(5)\fR to authorize otherwise non-privileged users to manage -\fBmemcached\fR services. -To let a user named \fBmyuser\fR change \fBmemcached\fR value properties and -manage \fBmemcached\fR service states, add the following line to -\fB/etc/user_attr\fR: -.sp -.in +2 -.nf -myuser::::type=role;profiles=Memcached Administration,All -.fi -.in -2 -.sp -.RE -.SH PACKAGE CONTENTS -.sp -.LP -The \fBmemcached\fR package consists of the memcached server and -man pages for the server. -.sp -.LP -Client libraries can be made available by installing other packages. -.sp -.LP -The memcached server is based on the memcached open-source software -available from http://www.danga.com/memcached/\&. -.SH SECURITY -.sp -.LP -When the memcached server is started, it listens for network requests -on a TCP port and/or a UDP port. It is important for the security of the network -that you protect this port, for example, by blocking access to this port in -a firewall. -.sp -.LP -The default TCP port number to use is 11211. -.sp -.LP -You may use the \fB-p\fR option to set another TCP port number. -There is no default UDP port number. You can use the \fB-U\fR option -to set a UDP port number. -.sp -.LP -If you are running memcached on a server with multiple network interfaces, -you can restrict vulnerability by binding memcached to a single interface -by using the \fB-l\fR option. -.LP -Caution - -.sp -.RS 2 -Note that \fBmemcached\fR was designed for speed -and not for security. There is no authentication of requests that go in to -the memcached servers, and communication is not encrypted. The network that -your memcached servers and clients run within should be safe-guarded against -network attacks. -.RE -.SH SEE ALSO -.sp -.LP -\fBlibmemcached(3libmemcached)\fR -.LP -Additional documentation (FAQ) can be found at http://www.eu.socialtext.net/memcached/index.cgi\&. -.SH NOTES -.sp -.LP -LICENSE -.sp -.LP -The \fBmemcached\fR daemon is copyright Danga Interactive -and is distributed under the BSD license. \fBmemcached\fR clients -are licensed separately. diff -r 2883c86b26b8 -r 634e69f7ae42 components/memcached/Solaris/memcached.8 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/components/memcached/Solaris/memcached.8 Fri Oct 23 14:22:44 2015 -0700 @@ -0,0 +1,487 @@ +'\" te +.TH memcached 8 "20 Oct 2015" "SunOS 5.12" "Administration Commands" +.SH NAME +memcached \- high performance memory object caching +system +.SH SYNOPSIS +.LP +.nf +\fBmemcached [\fB-l\fR \fI\fR] [\fB-d\fR] [\fB-u\fR \fI\fR] +[\fB-m\fR \fI\fR] [\fB-c\fR \fI\fR] [\fB-k\fR] [\fB-L \fR] +[\fB-p\fR \fI\fR] [\fB-U\fR \fI\fR] [\fB-s\fR \fI\fR] +[\fB-a\fR \fI\fR] [\fB-M\fR] [\fB-r\fR] [\fB-b\fR] +[\fB-f\fR \fI\fR] [\fB-n\fR \fI\fR] [\fB-h\fR] [\fB-v\fR] [\fB-vv\fR] [\fB-i\fR] +[\fB-P\fR \fI\fR] [\fB-t\fR \fI\fR] [\fB-D\fR \fI\fR]\fR +.fi + +.SH DESCRIPTION +.sp +.LP +\fBmemcached\fR is a flexible memory object caching daemon +designed to alleviate database load in dynamic web applications by storing +objects in memory. It is based on \fBlibevent\fR to scale to +any size needed, and is specifically optimized to avoid swapping and always +use non-blocking I/O. This man page documents briefly the \fBmemcached\fR memory +object caching daemon. +.SH OPTIONS +.sp +.LP +The options supported by the \fBmemcached\fR command are +described below. +.sp +.ne 2 +.mk +.na +\fB\fB-l\fR \fI\fR\fR +.ad +.RS 17n +.rt +Listen on \fI\fR; default +to \fBINADDR_ANY\fR. This is an important option to consider +as there is no other way to secure the installation. Binding to an internal +or fire walled network interface is suggested. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-d\fR\fR +.ad +.RS 17n +.rt +Run memcached as a daemon. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-u\fR \fI\fR\fR +.ad +.RS 17n +.rt +Assume the identity of \fI\fR only when run as a super user (root). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-m\fR \fI\fR\fR +.ad +.RS 17n +.rt +Use the maximum \fI\fR MB memory for object storage; the default is 64 MB. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-c\fR \fI\fR\fR +.ad +.RS 17n +.rt +Use the specified number of maximum simultaneous connections; +the default is 1024. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-k\fR\fR +.ad +.RS 17n +.rt +Lock down all paged memory. +.sp +Use this option with caution with large caches. For information about +the configuration suggestions, see the README and the memcached home page. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-L\fR\fR +.ad +.RS 17n +.rt +Preallocate memory and use large memory pages if possible. +.sp +This option will preallocate cache memory for object storage. +See description of \fB-m\fR option for a specification of the size of the memory. +If supported by the platform, large memory pages will be allocated. +This should reduce number of TLB misses and increase performance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-p\fR \fI\fR\fR +.ad +.RS 17n +.rt +Listen on the TCP port \fI\fR\&. +The default port is 11211. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-U\fR \fI\fR\fR +.ad +.RS 17n +.rt +Listen on the UDP port \fI\fR\&. +The default is 0, meaning that the UDP protocol is disabled. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-s\fR \fI\fR\fR +.ad +.RS 17n +.rt +Unix socket path to listen on (disables listening support for TCP and UDP). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-a\fR \fI\fR\fR +.ad +.RS 17n +.rt +Permissions (in octal format) for Unix socket created with \fB-s\fR option. +Default value is 0700. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-M\fR\fR +.ad +.RS 17n +.rt +Disable automatic removal of items from the cache when out +of memory. Additions will not be possible until adequate space is freed up. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-r\fR\fR +.ad +.RS 17n +.rt +Raise the core file size limit to the maximum allowable. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-b\fR\fR +.ad +.RS 17n +.rt +Run a managed instance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-f\fR \fI\fR\fR +.ad +.RS 17n +.rt +Use this option to specify \fI\fR as +the multiplier for computing the sizes of memory chunks that items are stored +in. A lower value may result in less wasted memory depending on the total +amount of memory available and the distribution of item sizes. The default +value is 1.25. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-n\fR \fI\fR\fR +.ad +.RS 17n +.rt +Allocate a minimum of \fI\fR bytes +for the item key, value, and flags. The default value is 48. If you have a +lot of small keys and values, you can get a significant memory efficiency +gain with a lower value. If you use a high chunk growth factor, that is \fB-f\fR option, you may want to increase the size to allow a bigger percentage +of your items to fit in the most densely packed smallest chunks. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-h\fR\fR +.ad +.RS 17n +.rt +Show the version of memcached and a summary of options. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-v\fR\fR +.ad +.RS 17n +.rt +Be verbose during the event loop; print out errors and warnings. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-vv\fR\fR +.ad +.RS 17n +.rt +Be even more verbose; same as \fB-v\fR option but +also print client commands and responses. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-i\fR\fR +.ad +.RS 17n +.rt +Display \fBmemcached\fR and \fBlibevent\fR licenses. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-P\fR \fI\fR\fR +.ad +.RS 17n +.rt +Print \fBpidfile\fR to the specified file. +.LP +Note - +.sp +.RS 2 +This option can be used only when \fBmechached\fR is +run as a daemon (\fB-d\fR option). +.RE +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-t\fR \fI\fR\fR +.ad +.RS 17n +.rt +Number of threads to use to process incoming requests. The default is 4. +It is typically not useful to set this much higher than the number of CPU cores +on the \fBmemcached\fR server. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-D\fR \fI\fR\fR +.ad +.RS 17n +.rt +Use the \fI\fR as the delimiter +between key prefixes and IDs. This is used for per-prefix statistics reporting. +The default is \fB:\fR (colon). If this option is specified, +statistics collection is turned on automatically; if not, then it can be turned +on by sending the \fBstats detail on\fR command to the server. +.RE + +.SH EXIT STATUS +.sp +.LP +The following exit values are returned: +.sp +.ne 2 +.mk +.na +\fB\fB0\fR\fR +.ad +.RS 5n +.rt +command executed successfully +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB1\fR\fR +.ad +.RS 5n +.rt +error in executing the command +.RE + +.SH SERVICE MANAGEMENT FACILITY +.sp +.LP +\fBmemcached\fR package for Solaris (\fBservice/memcached\fR) +includes files necessary to register with the Service Management Facility +described in \fISMF(7)\fR. The following procedure describes the steps to automate +the service management using memcached. +.RS +4 +.TP +1. +Add other parameters to be passed to the memcached service instance. +.sp +example: specify the server to use 1024 MB of memory +.sp +.in +2 +.nf +example% svccfg +svc:> select memcached +svc:/application/database/memcached> setprop memcached/options=("-m" "1024") +svc:/application/database/memcached> quit +example% svcadm refresh memcached +.fi +.in -2 + +.LP +Note - +.sp +.RS 2 +The arguments cannot be passed as a single string because of a limitation in \fIsvccfg\fR. +.RE +.RE +.RS +4 +.TP +2. +Enable memcached . +.sp +.in +2 +.nf +example% svcadm enable memcached +.fi +.in -2 + +The state of the service instance changes to \fBonline\fR, +and the memcached service instance must be started: +.sp +.in +2 +.nf +example% svcs memcached +STATE STIME FMRI +online 1:19:15 svc:/application/database/memcached:default +.fi +.in -2 +.sp + +.RE +.RS +4 +.TP +3. +To disable shutdown and automatic restart of memcached service instance, +.sp +.in +2 +.nf +example% svcadm disable memcached +.fi +.in -2 + +.RE +.SH USER AUTHORIZATIONS +.sp +.LP +You can use \fBRBAC(7)\fR to authorize otherwise non-privileged users to manage +\fBmemcached\fR services. +To let a user named \fBmyuser\fR change \fBmemcached\fR value properties and +manage \fBmemcached\fR service states, add the following line to +\fB/etc/user_attr\fR: +.sp +.in +2 +.nf +myuser::::type=role;profiles=Memcached Administration,All +.fi +.in -2 +.sp +.RE +.SH PACKAGE CONTENTS +.sp +.LP +The \fBmemcached\fR package consists of the memcached server and +man pages for the server. +.sp +.LP +Client libraries can be made available by installing other packages. +.sp +.LP +The memcached server is based on the memcached open-source software +available from http://www.danga.com/memcached/\&. +.SH SECURITY +.sp +.LP +When the memcached server is started, it listens for network requests +on a TCP port and/or a UDP port. It is important for the security of the network +that you protect this port, for example, by blocking access to this port in +a firewall. +.sp +.LP +The default TCP port number to use is 11211. +.sp +.LP +You may use the \fB-p\fR option to set another TCP port number. +There is no default UDP port number. You can use the \fB-U\fR option +to set a UDP port number. +.sp +.LP +If you are running memcached on a server with multiple network interfaces, +you can restrict vulnerability by binding memcached to a single interface +by using the \fB-l\fR option. +.LP +Caution - +.sp +.RS 2 +Note that \fBmemcached\fR was designed for speed +and not for security. There is no authentication of requests that go in to +the memcached servers, and communication is not encrypted. The network that +your memcached servers and clients run within should be safe-guarded against +network attacks. +.RE +.SH SEE ALSO +.sp +.LP +\fBlibmemcached(3libmemcached)\fR +.LP +Additional documentation (FAQ) can be found at http://www.eu.socialtext.net/memcached/index.cgi\&. +.SH NOTES +.sp +.LP +LICENSE +.sp +.LP +The \fBmemcached\fR daemon is copyright Danga Interactive +and is distributed under the BSD license. \fBmemcached\fR clients +are licensed separately. diff -r 2883c86b26b8 -r 634e69f7ae42 components/memcached/Solaris/memcached.xml --- a/components/memcached/Solaris/memcached.xml Fri Oct 23 05:42:31 2015 -0700 +++ b/components/memcached/Solaris/memcached.xml Fri Oct 23 14:22:44 2015 -0700 @@ -1,7 +1,7 @@