publish::CmdHelp Class Reference

#include <cmd_help.h>

Inheritance diagram for publish::CmdHelp:

Collaboration diagram for publish::CmdHelp:

Public Member Functions
	CmdHelp (CommandList *commands)
virtual std::string	GetName () const
virtual std::string	GetBrief () const
virtual std::string	GetUsage () const
virtual unsigned	GetMinPlainArgs () const
virtual ParameterList	GetParams () const
virtual int	Main (const Options &options)
Public Member Functions inherited from publish::Command
virtual	~Command ()
virtual std::string	GetDescription () const
std::string	GetExamples () const
virtual bool	IsHidden () const
Options	ParseOptions (int argc, char **argv)
std::string	progname () const

Private Attributes
CommandList *	commands_

Additional Inherited Members
Public Types inherited from publish::Command
typedef std::vector< Parameter >	ParameterList
Protected Member Functions inherited from publish::Command
virtual std::vector< std::string >	DoGetExamples () const

Detailed Description

Definition at line 14 of file cmd_help.h.

Constructor & Destructor Documentation

publish::CmdHelp::CmdHelp ( CommandList *  commands )

inlineexplicit

Definition at line 16 of file cmd_help.h.

Member Function Documentation

virtual std::string publish::CmdHelp::GetBrief ( ) const

inlinevirtual

A one-line explanation of what the command does

Implements publish::Command.

Definition at line 18 of file cmd_help.h.

virtual unsigned publish::CmdHelp::GetMinPlainArgs ( ) const

inlinevirtual

The command needs at least so many non-parameter arguments (e.g. fqrn)

Reimplemented from publish::Command.

Definition at line 22 of file cmd_help.h.

virtual std::string publish::CmdHelp::GetName ( ) const

inlinevirtual

Used to call the command as cvmfs_server $GetName() ...

Implements publish::Command.

Definition at line 17 of file cmd_help.h.

virtual ParameterList publish::CmdHelp::GetParams ( ) const

inlinevirtual

Returns the ordered array of possible parameters to this command

Implements publish::Command.

Definition at line 23 of file cmd_help.h.

virtual std::string publish::CmdHelp::GetUsage ( ) const

inlinevirtual

Reimplemented from publish::Command.

Definition at line 21 of file cmd_help.h.

int publish::CmdHelp::Main ( const Options &  options )

virtual

The dictionary of passed arguments can be obtained by a call to ParseOptions()

Implements publish::Command.

Definition at line 20 of file cmd_help.cc.

Here is the call graph for this function:

Member Data Documentation

CommandList* publish::CmdHelp::commands_

private

Definition at line 28 of file cmd_help.h.

---

The documentation for this class was generated from the following files:

• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/publish/cmd_help.h
• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/publish/cmd_help.cc