]> granicus.if.org Git - apache/commitdiff
add fresh suexec manpage
authorAndré Malo <nd@apache.org>
Tue, 29 Apr 2003 13:57:48 +0000 (13:57 +0000)
committerAndré Malo <nd@apache.org>
Tue, 29 Apr 2003 13:57:48 +0000 (13:57 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@99639 13f79535-47bb-0310-9956-ffa450edef68

docs/man/suexec.8
docs/manual/programs/suexec.html [deleted file]
docs/manual/programs/suexec.html.en [new file with mode: 0644]
docs/manual/programs/suexec.xml [new file with mode: 0644]
docs/manual/programs/suexec.xml.meta [new file with mode: 0644]

index e06ccc98fe3be7f29ca095023e8b1e4ba99dd812..8a7c3b46cfa88e0341a90649f519fc665b8956d4 100644 (file)
@@ -1,75 +1,47 @@
-.TH suexec 8 "March 2001"
-.\" The Apache Software License, Version 1.1
-.\"
-.\" Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
-.\" reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\"    notice, this list of conditions and the following disclaimer.
-.\"
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\"    notice, this list of conditions and the following disclaimer in
-.\"    the documentation and/or other materials provided with the
-.\"    distribution.
-.\"
-.\" 3. The end-user documentation included with the redistribution,
-.\"    if any, must include the following acknowledgment:
-.\"       "This product includes software developed by the
-.\"        Apache Software Foundation (http://www.apache.org/)."
-.\"    Alternately, this acknowledgment may appear in the software itself,
-.\"    if and wherever such third-party acknowledgments normally appear.
-.\"
-.\" 4. The names "Apache" and "Apache Software Foundation" must
-.\"    not be used to endorse or promote products derived from this
-.\"    software without prior written permission. For written
-.\"    permission, please contact apache@apache.org.
-.\"
-.\" 5. Products derived from this software may not be called "Apache",
-.\"    nor may "Apache" appear in their name, without prior written
-.\"    permission of the Apache Software Foundation.
-.\"
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
-.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-.\" DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
-.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" This software consists of voluntary contributions made by many
-.\" individuals on behalf of the Apache Software Foundation.  For more
-.\" information on the Apache Software Foundation, please see
-.\" <http://www.apache.org/>.
-.\"
-.SH NAME
-suexec \- Switch User For Exec
-.SH SYNOPSIS
-.B suexec -V
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
 .PP
-No other synopsis for usage, because this program
-is otherwise only used internally by the Apache HTTP server. 
+\fB\\$1\fR
 .PP
-.SH DESCRIPTION
-.B suexec
-is the "wrapper" support program for the suexec behaviour for the
-Apache HTTP server.  It is run from within the server automatically
-to switch the user when an external program has to be run under a
-different user. For more information about suexec, see the online
-document `Apache suexec Support' on the HTTP server project's
-Web site at  http://httpd.apache.org/docs/suexec.html .
-.SH OPTIONS
-.IP -V
-Display the list of compile-time settings used when \fBsuexec\fP
-was built.  No other action is taken.
-.PD
-.SH SEE ALSO
-.BR httpd(8)
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "SUEXEC" 8 "2003-04-29" "Apache HTTP Server" "suexec"
+
+.SH "SYNOPSIS"
+
+.PP
+\fBsuexec\fR -\fBV\fR
+
+
+.SH "SUMMARY"
+
+.PP
+suexec is used by the Apache HTTP Server to switch to another user before executing CGI programs\&. In order to achieve this, it must run as root\&. Since the HTTP daemon normally doesn't run as root, the suexec executable needs the setuid bit set and must be owned by root\&. It should never be writable for any other person than root\&.
+
+.PP
+For further information about the concepts and and the security model of suexec please refer to the suexec documentation (http://httpd\&.apache\&.org/docs-2\&.1/suexec\&.html)\&.
+
+
+.SH "OPTIONS"
+
+.RS
+
+.TP
+-V
+If you are root, this option displays the compile options of suexec\&. For security reasons all configuration options are changable only at compile time\&.
+.RE
+
diff --git a/docs/manual/programs/suexec.html b/docs/manual/programs/suexec.html
deleted file mode 100644 (file)
index bea3017..0000000
+++ /dev/null
@@ -1,52 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
-    <title>Manual Page: suexec - Apache HTTP Server</title>
-  </head>
-
-  <body bgcolor="#ffffff" text="#000000" link="#0000ff"
-  vlink="#000080" alink="#ff0000">
-        <div align="center">
-      <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" /> 
-
-      <h3>Apache HTTP Server Version 2.1</h3>
-    </div>
-
-
-
-    <h1 align="center">Manual Page: suexec</h1>
-    <!-- This document was autogenerated from the man page -->
-<pre>
-<strong>NAME</strong>
-     suexec - Switch User For Exec
-
-<strong>SYNOPSIS</strong>
-     No synopsis for usage, because this program is  used  inter-
-     nally by Apache only.
-
-<strong>DESCRIPTION</strong>
-     <strong>suexec</strong> is the  "wrapper"  support  program  for  the  suEXEC
-     behaviour for Apache.  It is run from within Apache automat-
-     ically to switch the user when an external program has to be
-     run  under  a  different  user.  For  more information about
-     suEXEC  see  the  document  `Apache  suEXEC  Support'  under
-     http://httpd.apache.org/docs-2.1/suexec.html .
-
-<strong>SEE ALSO</strong>
-     <strong>httpd(8)</strong>
-
-</pre>
-        <hr />
-
-    <h3 align="center">Apache HTTP Server Version 2.1</h3>
-    <a href="./"><img src="../images/index.gif" alt="Index" /></a>
-    <a href="../"><img src="../images/home.gif" alt="Home" /></a>
-
-
-  </body>
-</html>
-
diff --git a/docs/manual/programs/suexec.html.en b/docs/manual/programs/suexec.html.en
new file mode 100644 (file)
index 0000000..7c9b0eb
--- /dev/null
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+              This file is generated from xml source: DO NOT EDIT
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+      -->
+<title>suexec - Switch user before executing external programs - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.1</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>suexec - Switch user before executing external programs</h1>
+     <p><code>suexec</code> is used by the Apache HTTP Server to switch
+     to another user before executing CGI programs. In order to achieve this,
+     it must run as <code>root</code>. Since the HTTP daemon normally doesn't
+     run as <code>root</code>, the <code>suexec</code> executable needs the
+     setuid bit set and must be owned by <code>root</code>. It should never be
+     writable for any other person than <code>root</code>.</p>
+
+     <p>For further information about the concepts and and the security model
+     of suexec please refer to the suexec documentation (<a href="http://httpd.apache.org/docs-2.1/suexec.html">http://httpd.apache.org/docs-2.1/suexec.html</a>).</p>
+</div>
+<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
+</ul></div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
+     <p><code><strong>suexec</strong> -<strong>V</strong></code></p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="options" id="options">Options</a></h2>
+
+<dl>
+<dt><code>-V</code></dt>
+
+<dd>If you are <code>root</code>, this option displays the compile options of
+<code>suexec</code>. For security reasons all configuration options are
+changable only at compile time.</dd>
+
+</dl>
+</div></div>
+<div id="footer">
+<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html>
\ No newline at end of file
diff --git a/docs/manual/programs/suexec.xml b/docs/manual/programs/suexec.xml
new file mode 100644 (file)
index 0000000..0cd2392
--- /dev/null
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<manualpage metafile="suexec.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>suexec - Switch user before executing external programs</title>
+
+<summary>
+     <p><code>suexec</code> is used by the Apache HTTP Server to switch
+     to another user before executing CGI programs. In order to achieve this,
+     it must run as <code>root</code>. Since the HTTP daemon normally doesn't
+     run as <code>root</code>, the <code>suexec</code> executable needs the
+     setuid bit set and must be owned by <code>root</code>. It should never be
+     writable for any other person than <code>root</code>.</p>
+
+     <p>For further information about the concepts and and the security model
+     of suexec please refer to the suexec documentation (<a
+     href="http://httpd.apache.org/docs-2.1/suexec.html"
+     >http://httpd.apache.org/docs-2.1/suexec.html</a>).</p>
+</summary>
+
+<section id="synopsis"><title>Synopsis</title>
+     <p><code><strong>suexec</strong> -<strong>V</strong></code></p>
+</section>
+
+<section id="options"><title>Options</title>
+
+<dl>
+<dt><code>-V</code></dt>
+
+<dd>If you are <code>root</code>, this option displays the compile options of
+<code>suexec</code>. For security reasons all configuration options are
+changable only at compile time.</dd>
+
+</dl>
+</section>
+
+</manualpage>
diff --git a/docs/manual/programs/suexec.xml.meta b/docs/manual/programs/suexec.xml.meta
new file mode 100644 (file)
index 0000000..7f82920
--- /dev/null
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<metafile>
+  <basename>suexec</basename>
+  <path>/programs/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>