man Namespace Reference

Man page info. More...

Functions
void	print_manual ()
	Prints 'man page' style info.

Variables
const std::string	name
const std::string	author
const std::string	synopsis
const std::string	description
const std::vector< std::pair< std::string, std::string > >	options

Detailed Description

Man page info.

Function Documentation

print_manual()

void man::print_manual

(

)

Prints 'man page' style info.

Variable Documentation

name

const std::string man::name

Initial value:

{"ampsci - Atomic Many-body Perturbation theory in the "
                       "Screened Coulomb Interaction."}

author

const std::string man::author

Initial value:

{"Benjamin M. Roberts (https://broberts.io/), "
                         "University of Queensland, Australia."}

synopsis

const std::string man::synopsis

Initial value:

{"ampsci [InputFile]\n"
                           "ampsci [Atom] [Core] [Valence]\n"
                           "ampsci -s \"[Input String]\"\n"
                           "ampsci -i [InputBlock]\n"
                           "ampsci -m [Module]\n"
                           "ampsci -o [Operator]\n"
                           "ampsci -p [Atom] [Isotope]\n"
                           "ampsci -c [value] [unit]\n"}

description

const std::string man::description

Initial value:

{
  "ampsci is a C++ program for high-precision atomic structure calculations "
  "of single-valence systems.\n"
  "Full documentation (including of the physics methods) can be found "
  "online: https://ampsci.dev/"}