Documentation for /etc/subuid and /etc/subgid
Signed-off-by: "Eric W. Biederman" <ebiederm@xmission.com>
This commit is contained in:
		
				
					committed by
					
						 Serge Hallyn
						Serge Hallyn
					
				
			
			
				
	
			
			
			
						parent
						
							60fc4bbf57
						
					
				
				
					commit
					a881a2c8d4
				
			| @@ -43,6 +43,8 @@ man_MANS = \ | ||||
| 	man5/shadow.5 \ | ||||
| 	man1/su.1 \ | ||||
| 	man5/suauth.5 \ | ||||
| 	man5/subgid.5 \ | ||||
| 	man5/subuid.5 \ | ||||
| 	man8/useradd.8 \ | ||||
| 	man8/userdel.8 \ | ||||
| 	man8/usermod.8 \ | ||||
| @@ -94,6 +96,8 @@ man_XMANS = \ | ||||
| 	sg.1.xml \ | ||||
| 	su.1.xml \ | ||||
| 	suauth.5.xml \ | ||||
| 	subgid.5.xml \ | ||||
| 	subuid.5.xml \ | ||||
| 	useradd.8.xml \ | ||||
| 	userdel.8.xml \ | ||||
| 	usermod.8.xml \ | ||||
|   | ||||
							
								
								
									
										120
									
								
								man/subgid.5.xml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										120
									
								
								man/subgid.5.xml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,120 @@ | ||||
| <?xml version="1.0" encoding="UTF-8"?> | ||||
| <!-- | ||||
|    Copyright (c) 2013 Eric W. Biederman | ||||
|    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 name of the copyright holders or contributors may not be used to | ||||
|       endorse or promote products derived from this software without | ||||
|       specific prior written permission. | ||||
|    | ||||
|    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||||
|    ``AS IS'' AND ANY EXPRESS 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 COPYRIGHT | ||||
|    HOLDERS OR 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. | ||||
| --> | ||||
| <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN" | ||||
|   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ | ||||
| <!-- SHADOW-CONFIG-HERE --> | ||||
| ]> | ||||
| <refentry id='subgid.5'> | ||||
|   <refmeta> | ||||
|     <refentrytitle>subgid</refentrytitle> | ||||
|     <manvolnum>5</manvolnum> | ||||
|     <refmiscinfo class="sectdesc">File Formats and Conversions</refmiscinfo> | ||||
|     <refmiscinfo class="source">shadow-utils</refmiscinfo> | ||||
|     <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo> | ||||
|   </refmeta> | ||||
|   <refnamediv id='name'> | ||||
|     <refname>subgid</refname> | ||||
|     <refpurpose>the subordinate gid file</refpurpose> | ||||
|   </refnamediv> | ||||
|  | ||||
|   <refsect1 id='description'> | ||||
|     <title>DESCRIPTION</title> | ||||
|     <para> | ||||
|       Each line in <filename>/etc/subgid</filename> contains | ||||
|       a user id and a range of suboridinate user ids that user | ||||
|       is allowed to use. | ||||
|  | ||||
|       This is specified with three fields delimited by colons | ||||
|       (<quote>:</quote>). | ||||
|       These fields are: | ||||
|     </para> | ||||
|     <itemizedlist mark='bullet'> | ||||
|       <listitem> | ||||
| 	<para>login name</para> | ||||
|       </listitem> | ||||
|       <listitem> | ||||
| 	<para>numerical subordinate user ID</para> | ||||
|       </listitem> | ||||
|       <listitem> | ||||
| 	<para>numerical subordinate user ID count</para> | ||||
|       </listitem> | ||||
|     </itemizedlist> | ||||
|  | ||||
|     <para> | ||||
|       This file specifies the group IDs to be that each user may use | ||||
|       with the <command>newgidmap</command> command that ordinary users can use to | ||||
|       configure gid mapping in a user namespace. | ||||
|     </para> | ||||
|  | ||||
|     <para> | ||||
|       Multiple ranges may be specified per user ID. | ||||
|     </para> | ||||
|  | ||||
|   </refsect1> | ||||
|  | ||||
|   <refsect1 id='files'> | ||||
|     <title>FILES</title> | ||||
|     <variablelist> | ||||
|       <varlistentry> | ||||
| 	<term><filename>/etc/subgid</filename></term> | ||||
| 	<listitem> | ||||
| 	  <para>Per user subordinate group IDs.</para> | ||||
| 	</listitem> | ||||
|       </varlistentry> | ||||
|       <varlistentry> | ||||
| 	<term><filename>/etc/subgid-</filename></term> | ||||
| 	<listitem> | ||||
| 	  <para>Backup file for /etc/subgid.</para> | ||||
| 	</listitem> | ||||
|       </varlistentry> | ||||
|     </variablelist> | ||||
|   </refsect1> | ||||
|  | ||||
|   <refsect1 id='see_also'> | ||||
|     <title>SEE ALSO</title> | ||||
|     <para> | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>subuid</refentrytitle><manvolnum>5</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>logindefs</refentrytitle><manvolnum>5</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>newuidmap</refentrytitle><manvolnum>1</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>newgidmap</refentrytitle><manvolnum>1</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum> | ||||
|       </citerefentry>, | ||||
|     </para> | ||||
|   </refsect1> | ||||
| </refentry> | ||||
							
								
								
									
										120
									
								
								man/subuid.5.xml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										120
									
								
								man/subuid.5.xml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,120 @@ | ||||
| <?xml version="1.0" encoding="UTF-8"?> | ||||
| <!-- | ||||
|    Copyright (c) 2013 Eric W. Biederman | ||||
|    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 name of the copyright holders or contributors may not be used to | ||||
|       endorse or promote products derived from this software without | ||||
|       specific prior written permission. | ||||
|    | ||||
|    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||||
|    ``AS IS'' AND ANY EXPRESS 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 COPYRIGHT | ||||
|    HOLDERS OR 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. | ||||
| --> | ||||
| <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN" | ||||
|   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ | ||||
| <!-- SHADOW-CONFIG-HERE --> | ||||
| ]> | ||||
| <refentry id='subuid.5'> | ||||
|   <refmeta> | ||||
|     <refentrytitle>subuid</refentrytitle> | ||||
|     <manvolnum>5</manvolnum> | ||||
|     <refmiscinfo class="sectdesc">File Formats and Conversions</refmiscinfo> | ||||
|     <refmiscinfo class="source">shadow-utils</refmiscinfo> | ||||
|     <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo> | ||||
|   </refmeta> | ||||
|   <refnamediv id='name'> | ||||
|     <refname>subuid</refname> | ||||
|     <refpurpose>the subordinate uid file</refpurpose> | ||||
|   </refnamediv> | ||||
|  | ||||
|   <refsect1 id='description'> | ||||
|     <title>DESCRIPTION</title> | ||||
|     <para> | ||||
|       Each line in <filename>/etc/subuid</filename> contains | ||||
|       a user id and a range of suboridinate user ids that user | ||||
|       is allowed to use. | ||||
|  | ||||
|       This is specified with three fields delimited by colons | ||||
|       (<quote>:</quote>). | ||||
|       These fields are: | ||||
|     </para> | ||||
|     <itemizedlist mark='bullet'> | ||||
|       <listitem> | ||||
| 	<para>login name</para> | ||||
|       </listitem> | ||||
|       <listitem> | ||||
| 	<para>numerical subordinate user ID</para> | ||||
|       </listitem> | ||||
|       <listitem> | ||||
| 	<para>numerical subordinate user ID count</para> | ||||
|       </listitem> | ||||
|     </itemizedlist> | ||||
|  | ||||
|     <para> | ||||
|       This file specifies the user IDs to be that each user may use | ||||
|       with the <command>newuidmap</command> command that ordinary users can use to | ||||
|       configure uid mapping in a user namespace. | ||||
|     </para> | ||||
|  | ||||
|     <para> | ||||
|       Multiple ranges may be specified per user ID. | ||||
|     </para> | ||||
|  | ||||
|   </refsect1> | ||||
|  | ||||
|   <refsect1 id='files'> | ||||
|     <title>FILES</title> | ||||
|     <variablelist> | ||||
|       <varlistentry> | ||||
| 	<term><filename>/etc/subuid</filename></term> | ||||
| 	<listitem> | ||||
| 	  <para>Per user subordinate user IDs.</para> | ||||
| 	</listitem> | ||||
|       </varlistentry> | ||||
|       <varlistentry> | ||||
| 	<term><filename>/etc/subuid-</filename></term> | ||||
| 	<listitem> | ||||
| 	  <para>Backup file for /etc/subuid.</para> | ||||
| 	</listitem> | ||||
|       </varlistentry> | ||||
|     </variablelist> | ||||
|   </refsect1> | ||||
|  | ||||
|   <refsect1 id='see_also'> | ||||
|     <title>SEE ALSO</title> | ||||
|     <para> | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>subgid</refentrytitle><manvolnum>5</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>logindefs</refentrytitle><manvolnum>5</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>newuidmap</refentrytitle><manvolnum>1</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>newgidmap</refentrytitle><manvolnum>1</manvolnum> | ||||
|       </citerefentry>, | ||||
|       <citerefentry> | ||||
| 	<refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum> | ||||
|       </citerefentry>, | ||||
|     </para> | ||||
|   </refsect1> | ||||
| </refentry> | ||||
		Reference in New Issue
	
	Block a user