path: root/Help.cpp

#include "Help.h"
#include "Compass.h"

Help::Help() {
	std::cout << "   ______                ____  ___   __________" << std::endl;
	std::cout << "  / ____/___  ____ ___  / __ \\/   | / ___/ ___/" << std::endl;
	std::cout << " / /   / __ \\/ __ `__ \\/ /_/ / /| | \\__ \\\\__ \\ " << std::endl;
	std::cout << "/ /___/ /_/ / / / / / / ____/ ___ |___/ /__/ / " << std::endl;
	std::cout << "\\____/\\____/_/ /_/ /_/_/   /_/  |_/____/____/  " << std::endl;
	std::cout << std::endl;

    std::cout << "                    " << COMPASS_VERSION << std::endl;
    std::cout << std::endl;

	std::cout << "            Minimal::Documentation" << std::endl;
	std::cout << std::endl;
}

Help::~Help() {
	std::cout << std::endl;
	std::cout << "END" << std::endl;
}

void Help::dispGeneral() {
	std::cout << "USAGE: compass <action> [args] [-options]" << std::endl;
	std::cout << std::endl;

	std::cout << "Different actions tell compass what work to do. They are listed here..." << std::endl;
	std::cout << std::endl;

	std::cout << "help                This output" << std::endl;
	std::cout << "initialize          Create a new, empty keychain" << std::endl;
	std::cout << "create              Add a credential to a keychain" << std::endl;
	std::cout << "rekey               Change a keychain's master password" << std::endl;
	std::cout << "get                 Retrieve a credential from a keychain" << std::endl;
	std::cout << "delete              Remove one or more credentials from a keychain" << std::endl;
	std::cout << "show                View contents of a keychain" << std::endl;
	std::cout << "show1               View credentials for a particular entry in a keychain" << std::endl;
	std::cout << "showlike            Search a keychain for contents" << std::endl;
	std::cout << "random              Generate noise" << std::endl;
	std::cout << "markreset           Mark all credentials in a keychain for reset" << std::endl;
	std::cout << "markreset1          Mark all credentials for a specific entry in a keychain for reset" << std::endl;
	std::cout << "checkreset          Count credentials marked for reset in a keychain" << std::endl;
	std::cout << "checkreset1         Count credentials marked for reset in a specific entry in a keychain" << std::endl;
	std::cout << "ruser               Reset the username for a credential in a keychain" << std::endl;
	std::cout << "rpass               Reset the password for a credential in a keychain" << std::endl;
	std::cout << std::endl;

	std::cout << "Different options (flags) tell compass actions how to do their work. They are listed here..." << std::endl;
	std::cout << std::endl;

	std::cout << "-user <username>    Used to disambiguate credentials if lookups return more than one" << std::endl;
	std::cout << "                    Also used to specify a username value for new or updated credentials" << std::endl;
	std::cout << "-pass <password>    Used to specify a password value for new or updated credentials" << std::endl;
	std::cout << "-dr   <path>        Directory to look for, or put, keychain in" << std::endl;
	std::cout << "-cn   <number>      Used to disambiguate credentials if lookups return more than one" << std::endl;
	std::cout << "-ml   <length>      Password Gen Option: max-length for generated string" << std::endl;
	std::cout << "-ns                 Password Gen Option: set this if no special chars should be used" << std::endl;
	std::cout << "-nc                 Password Gen Option: set this if no caps should be used" << std::endl;
	std::cout << "-nn                 Password Gen Option: set this if no numbers should be used" << std::endl;
	std::cout << "-pp                 Set this to prevent output from pasting passwords to the clipboard" << std::endl;
	std::cout << "-cc                 Set this to prevent automatic clipboard cleaning" << std::endl;
}