granicus.if.org Git - shadow/blob - man/vipw.8.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 1997       , Marek Michałkiewicz
   4    Copyright (c) 2001 - 2006, Tomasz Kłoczko
   5    Copyright (c) 2007 - 2011, Nicolas François
   6    All rights reserved.
   7
   8    Redistribution and use in source and binary forms, with or without
   9    modification, are permitted provided that the following conditions
  10    are met:
  11    1. Redistributions of source code must retain the above copyright
  12       notice, this list of conditions and the following disclaimer.
  13    2. Redistributions in binary form must reproduce the above copyright
  14       notice, this list of conditions and the following disclaimer in the
  15       documentation and/or other materials provided with the distribution.
  16    3. The name of the copyright holders or contributors may not be used to
  17       endorse or promote products derived from this software without
  18       specific prior written permission.
  19
  20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  24    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 -->
  32 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  33   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  34 <!ENTITY USE_TCB               SYSTEM "login.defs.d/USE_TCB.xml">
  35 <!-- SHADOW-CONFIG-HERE -->
  36 ]>
  37 <refentry id='vipw.8'>
  38   <!--  $Id$  -->
  39   <refentryinfo>
  40     <author>
  41       <firstname>Marek</firstname>
  42       <surname>Michałkiewicz</surname>
  43       <contrib>Creation, 1997</contrib>
  44     </author>
  45     <author>
  46       <firstname>Thomas</firstname>
  47       <surname>Kłoczko</surname>
  48       <email>kloczek@pld.org.pl</email>
  49       <contrib>shadow-utils maintainer, 2000 - 2007</contrib>
  50     </author>
  51     <author>
  52       <firstname>Nicolas</firstname>
  53       <surname>François</surname>
  54       <email>nicolas.francois@centraliens.net</email>
  55       <contrib>shadow-utils maintainer, 2007 - now</contrib>
  56     </author>
  57   </refentryinfo>
  58   <refmeta>
  59     <refentrytitle>vipw</refentrytitle>
  60     <manvolnum>8</manvolnum>
  61     <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  62     <refmiscinfo class="source">shadow-utils</refmiscinfo>
  63     <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo>
  64   </refmeta>
  65   <refnamediv id='name'>
  66     <refname>vipw</refname>
  67     <refname>vigr</refname>
  68     <refpurpose>
  69       edit the password, group, shadow-password or shadow-group file
  70     </refpurpose>
  71   </refnamediv>
  72
  73   <refsynopsisdiv id='synopsis'>
  74     <cmdsynopsis>
  75       <command>vipw</command>
  76       <arg choice='opt'>
  77         <replaceable>options</replaceable>
  78       </arg>
  79     </cmdsynopsis>
  80     <cmdsynopsis>
  81       <command>vigr</command>
  82       <arg choice='opt'>
  83         <replaceable>options</replaceable>
  84       </arg>
  85     </cmdsynopsis>
  86   </refsynopsisdiv>
  87
  88   <refsect1 id='description'>
  89     <title>DESCRIPTION</title>
  90     <para>
  91       The <command>vipw</command> and <command>vigr</command> commands edits
  92       the files <filename>/etc/passwd</filename> and
  93       <filename>/etc/group</filename>, respectively. With the
  94       <option>-s</option> flag, they will edit the shadow versions of those
  95       files, <filename>/etc/shadow</filename> and
  96       <filename>/etc/gshadow</filename>, respectively. The programs will set
  97       the appropriate locks to prevent file corruption. When looking for an
  98       editor, the programs will first try the environment variable
  99       <envar>$VISUAL</envar>, then the environment variable
 100       <envar>$EDITOR</envar>, and finally the default editor,
 101       <citerefentry><refentrytitle>vi</refentrytitle>
 102       <manvolnum>1</manvolnum></citerefentry>.
 103     </para>
 104   </refsect1>
 105
 106   <refsect1 id='options'>
 107     <title>OPTIONS</title>
 108     <para>
 109       The options which apply to the <command>vipw</command> and
 110       <command>vigr</command> commands are:
 111     </para>
 112     <variablelist remap='IP'>
 113       <varlistentry>
 114         <term><option>-g</option>, <option>--group</option></term>
 115         <listitem>
 116           <para>Edit group database.</para>
 117         </listitem>
 118       </varlistentry>
 119       <varlistentry>
 120         <term><option>-h</option>, <option>--help</option></term>
 121         <listitem>
 122           <para>Display help message and exit.</para>
 123         </listitem>
 124       </varlistentry>
 125       <varlistentry>
 126         <term><option>-p</option>, <option>--passwd</option></term>
 127         <listitem>
 128           <para>Edit passwd database.</para>
 129         </listitem>
 130       </varlistentry>
 131       <varlistentry>
 132         <term><option>-q</option>, <option>--quiet</option></term>
 133         <listitem>
 134           <para>Quiet mode.</para>
 135         </listitem>
 136       </varlistentry>
 137       <varlistentry>
 138         <term>
 139           <option>-R</option>, <option>--root</option>&nbsp;<replaceable>CHROOT_DIR</replaceable>
 140         </term>
 141         <listitem>
 142           <para>
 143             Apply changes in the <replaceable>CHROOT_DIR</replaceable>
 144             directory and use the configuration files from the
 145             <replaceable>CHROOT_DIR</replaceable> directory.
 146           </para>
 147         </listitem>
 148       </varlistentry>
 149       <varlistentry>
 150         <term><option>-s</option>, <option>--shadow</option></term>
 151         <listitem>
 152           <para>Edit shadow or gshadow database.</para>
 153         </listitem>
 154       </varlistentry>
 155       <varlistentry condition="tcb">
 156         <term><option>-u</option>, <option>--user</option></term>
 157         <listitem>
 158           <para>Indicates which user's tcb shadow file to edit.</para>
 159         </listitem>
 160       </varlistentry>
 161     </variablelist>
 162   </refsect1>
 163
 164   <refsect1 id='configuration' condition="tcb">
 165     <title>CONFIGURATION</title>
 166     <para>
 167       The following configuration variables in
 168       <filename>/etc/login.defs</filename> change the behavior of this
 169       tool:
 170     </para>
 171     <variablelist>
 172       &USE_TCB;
 173     </variablelist>
 174   </refsect1>
 175
 176   <refsect1 id='environment'>
 177     <title>ENVIRONMENT</title>
 178     <variablelist>
 179       <varlistentry>
 180         <term><option>VISUAL</option></term>
 181         <listitem>
 182           <para>Editor to be used.</para>
 183         </listitem>
 184       </varlistentry>
 185       <varlistentry>
 186         <term><option>EDITOR</option></term>
 187         <listitem>
 188           <para>Editor to be used if <option>VISUAL</option> is not set.</para>
 189         </listitem>
 190       </varlistentry>
 191     </variablelist>
 192   </refsect1>
 193
 194   <refsect1 id='files'>
 195     <title>FILES</title>
 196     <variablelist>
 197       <varlistentry>
 198         <term><filename>/etc/group</filename></term>
 199         <listitem>
 200           <para>Group account information.</para>
 201         </listitem>
 202       </varlistentry>
 203       <varlistentry>
 204         <term><filename>/etc/gshadow</filename></term>
 205         <listitem>
 206           <para>Secure group account information.</para>
 207         </listitem>
 208       </varlistentry>
 209       <varlistentry>
 210         <term><filename>/etc/passwd</filename></term>
 211         <listitem>
 212           <para>User account information.</para>
 213         </listitem>
 214       </varlistentry>
 215       <varlistentry>
 216         <term><filename>/etc/shadow</filename></term>
 217         <listitem>
 218           <para>Secure user account information.</para>
 219         </listitem>
 220       </varlistentry>
 221     </variablelist>
 222   </refsect1>
 223
 224   <refsect1 id='see_also'>
 225     <title>SEE ALSO</title>
 226     <para>
 227       <citerefentry>
 228         <refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum>
 229       </citerefentry>,
 230       <citerefentry>
 231         <refentrytitle>group</refentrytitle><manvolnum>5</manvolnum>
 232       </citerefentry>,
 233       <citerefentry>
 234         <refentrytitle>gshadow</refentrytitle><manvolnum>5</manvolnum>
 235       </citerefentry>
 236       <citerefentry condition="tcb">
 237         <refentrytitle>login.defs</refentrytitle><manvolnum>5</manvolnum>
 238       </citerefentry>,
 239       <citerefentry>
 240         <refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum>
 241       </citerefentry>,
 242       <citerefentry condition="tcb">
 243         <refentrytitle>tcb</refentrytitle><manvolnum>5</manvolnum>
 244       </citerefentry>,
 245       <citerefentry>
 246         <refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum>
 247       </citerefentry>.
 248     </para>
 249   </refsect1>
 250 </refentry>