help.h File Reference

#include <string>
#include "core/common.h"

Include dependency graph for help.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
std::string	usage ()
std::string	general_options ()
void	overview (int status)
void	help (master_t master, controller_t controller, int status)

Detailed Description

This file defines helper functions to display help messages on the command-line.

Definition in file help.h.

Function Documentation

general_options()

std::string general_options

(

)

Returns

explanation of general options.

Definition at line 20 of file help.cc.

help()

void help	(	master_t	master,
		controller_t	controller,
		int	status
	)

Print help message when '-h' or '–help' flag is given.

Parameters

master	master type.
controller	controller type.
status	exit status.

Definition at line 64 of file help.cc.

overview()

void overview

(

int

status

)

Print an overview of available help messages.

Parameters

status

exit status.

Definition at line 32 of file help.cc.

usage()

std::string usage

(

)

Returns

usage format.

Definition at line 9 of file help.cc.