granicus.if.org Git - shadow/blob - man/groups.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 1991 - 1994, Julianne Frances Haugh
   4    Copyright (c) 2007 - 2008, Nicolas François
   5    All rights reserved.
   6
   7    Redistribution and use in source and binary forms, with or without
   8    modification, are permitted provided that the following conditions
   9    are met:
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15    3. The name of the copyright holders or contributors may not be used to
  16       endorse or promote products derived from this software without
  17       specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  23    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 -->
  31 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  32   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  33 <!-- SHADOW-CONFIG-HERE -->
  34 ]>
  35 <refentry id='groups.1'>
  36   <!-- $Id$ -->
  37   <refentryinfo>
  38     <author>
  39       <firstname>Julianne Frances</firstname>
  40       <surname>Haugh</surname>
  41       <contrib>Creation, 1991</contrib>
  42     </author>
  43     <author>
  44       <firstname>Thomas</firstname>
  45       <surname>Kłoczko</surname>
  46       <email>kloczek@pld.org.pl</email>
  47       <contrib>shadow-utils maintainer, 2000 - 2007</contrib>
  48     </author>
  49     <author>
  50       <firstname>Nicolas</firstname>
  51       <surname>François</surname>
  52       <email>nicolas.francois@centraliens.net</email>
  53       <contrib>shadow-utils maintainer, 2007 - now</contrib>
  54     </author>
  55   </refentryinfo>
  56   <refmeta>
  57     <refentrytitle>groups</refentrytitle>
  58     <manvolnum>1</manvolnum>
  59     <refmiscinfo class="sectdesc">User Commands</refmiscinfo>
  60     <refmiscinfo class="source">shadow-utils</refmiscinfo>
  61     <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo>
  62   </refmeta>
  63   <refnamediv id='name'>
  64     <refname>groups</refname>
  65     <refpurpose>display current group names</refpurpose>
  66   </refnamediv>
  67
  68   <refsynopsisdiv id='synopsis'>
  69     <cmdsynopsis>
  70       <command>groups</command>
  71       <arg choice='opt'>
  72         <replaceable>user</replaceable>
  73       </arg>
  74     </cmdsynopsis>
  75   </refsynopsisdiv>
  76
  77   <refsect1 id='description'>
  78     <title>DESCRIPTION</title>
  79     <para>
  80       The <command>groups</command> command displays the current group names
  81       or ID values. If the value does not have a corresponding entry in
  82       <filename>/etc/group</filename>, the value will be displayed as the
  83       numerical group value. The optional <emphasis
  84       remap='I'>user</emphasis> parameter will display the groups for the
  85       named <emphasis remap='I'>user</emphasis>.
  86     </para>
  87   </refsect1>
  88
  89   <refsect1 id='note'>
  90     <title>NOTE</title>
  91     <para>
  92       Systems which do not support concurrent group sets will have the
  93       information from <filename>/etc/group</filename> reported. The user
  94       must use <command>newgrp</command> or <command>sg</command> to change
  95       his current real and effective group ID.
  96     </para>
  97   </refsect1>
  98
  99   <refsect1 id='files'>
 100     <title>FILES</title>
 101     <variablelist>
 102       <varlistentry>
 103         <term><filename>/etc/group</filename></term>
 104         <listitem>
 105           <para>Group account information.</para>
 106         </listitem>
 107       </varlistentry>
 108     </variablelist>
 109   </refsect1>
 110
 111   <refsect1 id='see_also'>
 112     <title>SEE ALSO</title>
 113     <para>
 114       <citerefentry>
 115         <refentrytitle>newgrp</refentrytitle><manvolnum>1</manvolnum>
 116       </citerefentry>,
 117       <citerefentry>
 118         <refentrytitle>getgid</refentrytitle><manvolnum>2</manvolnum>
 119       </citerefentry>,
 120       <citerefentry>
 121         <refentrytitle>getgroups</refentrytitle><manvolnum>2</manvolnum>
 122       </citerefentry>,
 123       <citerefentry>
 124         <refentrytitle>getuid</refentrytitle><manvolnum>2</manvolnum>
 125       </citerefentry>.
 126     </para>
 127   </refsect1>
 128 </refentry>