HelpFunctions.cpp File Reference

This is the file in charge of displaying the help message. More...

#include <iostream>
#include "Constants.hpp"

Include dependency graph for HelpFunctions.cpp:

Go to the source code of this file.

Functions
void	DisplayVersion (bool helpMode=false)
	Displays version information for the program.
void	DisplayHelp (const std::string binName)
	The main function of the help display.

Detailed Description

This is the file in charge of displaying the help message.

Definition in file HelpFunctions.cpp.

Function Documentation

DisplayHelp()

void DisplayHelp

(

const std::string

binName

)

The main function of the help display.

Parameters

binName

Name of the executable binary.

Definition at line 101 of file HelpFunctions.cpp.

DisplayVersion()

void DisplayVersion

(

bool

helpMode = false

)

Displays version information for the program.

Parameters

helpMode

If true, will prepend a 'VERSION\:\n' string to the output (default: false).

Definition at line 88 of file HelpFunctions.cpp.