src/Darcs/Commands/Show.lhs

   1 %  Copyright (C) 2002-2004 David Roundy
   2 %
   3 %  This program is free software; you can redistribute it and/or modify
   4 %  it under the terms of the GNU General Public License as published by
   5 %  the Free Software Foundation; either version 2, or (at your option)
   6 %  any later version.
   7 %
   8 %  This program is distributed in the hope that it will be useful,
   9 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 %  GNU General Public License for more details.
  12 %
  13 %  You should have received a copy of the GNU General Public License
  14 %  along with this program; see the file COPYING.  If not, write to
  15 %  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16 %  Boston, MA 02110-1301, USA.
  17
  18 \begin{code}
  19 module Darcs.Commands.Show ( show_command, list, query ) where
  20
  21 import Darcs.Commands ( DarcsCommand(..),
  22                         CommandControl(Command_data, Hidden_command),
  23                         command_alias,
  24                       )
  25 import Darcs.Commands.ShowAuthors ( show_authors )
  26 import Darcs.Commands.ShowBug ( show_bug )
  27 import Darcs.Commands.ShowContents ( show_contents )
  28 import Darcs.Commands.ShowFiles ( show_files, show_manifest )
  29 import Darcs.Commands.ShowTags ( show_tags )
  30 import Darcs.Commands.ShowRepo ( show_repo )
  31 import Darcs.Repository ( amInRepository )
  32
  33 show_description :: String
  34 show_description = "Show information which is stored by darcs."
  35
  36 show_help :: String
  37 show_help =
  38  "Use the --help option with the subcommands to obtain help for\n"++
  39  "subcommands (for example, \"darcs show files --help\").\n"
  40
  41 show_command :: DarcsCommand
  42 show_command = SuperCommand {command_name = "show",
  43                       command_help = show_help,
  44                       command_description = show_description,
  45                       command_prereq = amInRepository,
  46                       command_sub_commands = [Hidden_command show_bug,
  47                                               Command_data show_contents,
  48                                               Command_data show_files, Hidden_command show_manifest,
  49                                               Command_data show_repo,
  50                                               Command_data show_authors,
  51                                               Command_data show_tags]
  52                      }
  53
  54 query :: DarcsCommand
  55 query = command_alias "query" show_command
  56
  57 list :: DarcsCommand
  58 list = command_alias "list" show_command
  59 \end{code}
  60
  61 \subsection{darcs show}
  62
  63 The show command provides access to several subcommands which can be
  64 used to investigate the state of a repository.
  65
  66 \input{Darcs/Commands/ShowAuthors.lhs}
  67 \input{Darcs/Commands/ShowContents.lhs}
  68 \input{Darcs/Commands/ShowFiles.lhs}
  69 \input{Darcs/Commands/ShowTags.lhs}
  70 \input{Darcs/Commands/ShowRepo.lhs}
  71