kde-dev-scripts/doc/man-cvscheck.1.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY cvscheck "<command>cvscheck</command>">
0004 <!ENTITY CVS "<acronym>CVS</acronym>">
0005 <!ENTITY % English "INCLUDE">
0006 ]>
0007
0008 <refentry lang="&language;">
0009 <refentryinfo>
0010 <date>2003-03-08</date>
0011 </refentryinfo>
0012
0013 <refmeta>
0014 <refentrytitle>&cvscheck;</refentrytitle>
0015 <manvolnum>1</manvolnum>
0016 </refmeta>
0017
0018 <refnamediv>
0019 <refname>&cvscheck;</refname>
0020 <refpurpose>Offline status report for files in a checked-out &CVS; module.</refpurpose>
0021 </refnamediv>
0022
0023 <refsynopsisdiv>
0024 <cmdsynopsis>
0025 &cvscheck;
0026 <group><replaceable>dir</replaceable></group>
0027
0028 </cmdsynopsis>
0029 </refsynopsisdiv>
0030
0031 <refsect1>
0032 <title>Description</title>
0033
0034 <para>&cvscheck; prints information about the status of your local
0035 &CVS; checkout without communicating with the server. This means it is
0036 extremely fast and does not require a network connection.</para>
0037
0038 <para>The given directory and all of its subdirectories will be
0039 processed recursively. If no directory is given, the current directory
0040 and its recursed subdirectories will be used.</para>
0041
0042 <para>Each file with an interesting status will be printed with a
0043 status character in front of its name. The status characters are as
0044 follows.</para>
0045
0046 <variablelist>
0047 <varlistentry>
0048 <term><returnvalue>?</returnvalue> <filename>foobar.c</filename></term>
0049 <listitem>
0050 <para>The file is not known to &CVS;</para>
0051 </listitem>
0052 </varlistentry>
0053 <varlistentry>
0054 <term><returnvalue>M</returnvalue>
0055 <filename>foobar.c</filename></term>
0056 <listitem>
0057 <para>The file is definitely locally modified</para>
0058 </listitem>
0059 </varlistentry>
0060 <varlistentry>
0061 <term><returnvalue>m</returnvalue>
0062 <filename>foobar.c</filename></term>
0063 <listitem>
0064 <para>The file <emphasis>might</emphasis> have local changes. You
0065 should <command>diff</command> with the server to make sure.</para>
0066 </listitem>
0067 </varlistentry>
0068 <varlistentry>
0069 <term><returnvalue>C</returnvalue>
0070 <filename>foobar.c</filename></term>
0071 <listitem>
0072 <para>The file has a &CVS; conflict and therefore cannot be
0073 committed.</para>
0074 </listitem>
0075 </varlistentry>
0076 <varlistentry>
0077 <term><returnvalue>U</returnvalue>
0078 <filename>foobar.c</filename></term>
0079 <listitem>
0080 <para>This file is in &CVS; but is missing in your local
0081 checkout.</para>
0082 </listitem>
0083 </varlistentry>
0084 <varlistentry>
0085 <term><returnvalue>T</returnvalue>
0086 <filename>foobar.c</filename></term>
0087 <listitem><para>This file has an unusual sticky &CVS;
0088 tag.</para></listitem>
0089 </varlistentry>
0090 <varlistentry>
0091 <term><returnvalue>A</returnvalue>
0092 <filename>foobar.c</filename></term>
0093 <listitem>
0094 <para>You have done a <userinput><command>cvs</command>
0095 <option>add</option></userinput> for this file, but have not yet committed
0096 it.</para>
0097 </listitem>
0098 </varlistentry>
0099 <varlistentry>
0100 <term><returnvalue>R</returnvalue>
0101 <filename>foobar.c</filename></term>
0102 <listitem>
0103 <para>You have done a <userinput><command>cvs</command>
0104 <option>rm</option></userinput> for this file, but have not yet committed
0105 it.</para>
0106 </listitem>
0107 </varlistentry>
0108 </variablelist>
0109
0110 <para>This utility is part of the &kde; Software Development Kit.</para>
0111
0112 </refsect1>
0113
0114 <refsect1>
0115 <title>See Also</title>
0116
0117 <para>cvs(1)</para>
0118
0119 </refsect1>
0120
0121 <refsect1>
0122 <title>Authors</title>
0123
0124 <para>cvscheck was written by &Dirk.Mueller; &Dirk.Mueller.mail;
0125  and &Sirtaj.Singh.Kang; &Sirtaj.Singh.Kang.mail;</para>
0126
0127 <para>This manual page was prepared by
0128 <personname><firstname>Ben</firstname>
0129 <surname>Burton</surname></personname> <email>bab@debian.org</email> for the
0130 Debian GNU/Linux system (but may be used by others).
0131  </para>
0132 </refsect1>
0133
0134 </refentry>