<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<!--
#
# This file is part of Freedom Maker.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
-->
<refentry>
  <refmeta>
    <refentrytitle><application>passwd-in-image</application></refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="manual">FreedomBox Manual</refmiscinfo>
    <refmiscinfo class="version">0.8</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname><application>passwd-in-image</application></refname>
    <refpurpose>
      change password of a user inside a disk image file
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>passwd-in-image</command>
      <arg><option>image</option></arg>
      <arg><option>user</option></arg>
      <arg><option>--password</option><arg choice="req">PASSWORD</arg></arg>
      <arg><option>-h, </option><option>--help</option></arg>
   </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      FreedomBox is a community project to develop, design and promote
      personal servers running free software for private, personal
      communications.  It is a networking appliance designed to allow
      interfacing with the rest of the Internet under conditions of
      protected privacy and data security.  It hosts applications such
      as blog, wiki, website, social network, email, web proxy and a
      Tor relay on a device that can replace a wireless router so that
      data stays with the users.
    </para>
    <para>
      freedom-maker is a tool to build FreedomBox images for various single
      board computers, virtual machines and general purpose computers.
    </para>
    <para>
      Password in image script lets you change the password of a user in an
      image file generated by freedom-maker.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><option>image</option></term>
        <listitem>
          <para>
            Disk image file (.img or .vdi) inside which user manipulation is
            sought.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>user</option></term>
         <listitem>
          <para>
            User account to change password for.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--password PASSWORD</option></term>
         <listitem>
          <para>
            New password for the user.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <example>
      <title>Change password for fbx default user in BeagleBone image</title>
      <synopsis>$ passwd-in-image freedom-maker-beaglebone.img fbx
      --password somepassword</synopsis>
      <para>
        Change the password of the user with username someuser to somepassword.
      </para>
    </example>
  </refsect1>

  <refsect1>
    <title>Bugs</title>
    <para>
      See the <ulink
      url="https://github.com/freedombox/freedom-maker/issues">freedom-maker
      issue tracker</ulink> for a full list of known issues and TODO items.
    </para>
  </refsect1>

  <refsect1>
    <title>Author</title>
    <para>
      <author>
        <firstname>FreedomBox Developers</firstname>
        <contrib>Original author</contrib>
      </author>
    </para>
  </refsect1>
</refentry>
