ostree/doc/ostree-ls.xml
Colin Walters 546237cc6f docs: Fix a pile of Docbook validation errors
At least now validates with RNG mode in Emacs.
2014-11-29 12:15:21 -05:00

118 lines
4.2 KiB
XML

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
-->
<refentry id="ostree">
<refentryinfo>
<title>ostree ls</title>
<productname>OSTree</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Colin</firstname>
<surname>Walters</surname>
<email>walters@verbum.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>ostree ls</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-ls</refname>
<refpurpose>List file paths</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree ls</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt" rep="repeat">PATHS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Prints a list of file paths within the given commit, and within the given path(s) if specified. The first letter of the file line output specifies the type: "-" for regular file, "d" for directory, "l" for symbolic link. See EXAMPLE section for more detail on the specific output.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--dironly</option>,<option>-d</option></term>
<listitem><para>
Do not recurse into directory arguments.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--recursive</option>,<option>-R</option></term>
<listitem><para>
Print directories recursively.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--checksum</option>,<option>-C</option></term>
<listitem><para>
Print checksum.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--xattrs</option>,<option>-X</option></term>
<listitem><para>
Print extended attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nul-filenames-only</option></term>
<listitem><para>
Print only filenames, NUL separated.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- Check this example. Are the descriptions correct?? -->
<refsect1>
<title>Example</title>
<para><command>$ ostree ls my-branch</command></para>
<programlisting>
d00644 0 0 0 /
-00644 0 0 2 /helloworld.txt
d00755 0 0 0 /testdirectory
</programlisting>
<para>Here, the first column is the file-type symbol (as explained in the DESCRIPTION section) followed by the S_IFMT file type. The next two columns (here: 0 0) are respectively the user ID and group ID for the file. After the break, the next number represents that file's standard size. The final column is the file path.</para>
</refsect1>
</refentry>