help.hpp

   1 /**********************************************************************
   2  * Title: Anagram
   3  * Description: Application for finding anagrams of a word
   4  * Author: Agnibho Mondal
   5  * Website: http://code.agnibho.com/anagram
   6  **********************************************************************
   7    Copyright (c) 2013-2015 Agnibho Mondal
   8    All rights reserved
   9  **********************************************************************
  10    This file is part of Anagram.
  11
  12    Anagram is free software: you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation, either version 3 of the License, or
  15    (at your option) any later version.
  16
  17    Anagram is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with Anagram.  If not, see <http://www.gnu.org/licenses/>.
  24  **********************************************************************/
  25 #ifndef HELP
  26 #define HELP
  27
  28 /*
  29  * Shows a manual about how to use this program
  30  */
  31
  32 #include <iostream>
  33
  34 int show_help(){ //Displays help on console
  35   cout<<
  36     "Anagram 2.0\n\n"
  37     "anagram [-hmpP] word [word2]\n\n"
  38     "\t The program finds the possible angrams of the 'word' from a dictionary.\n"
  39     "\t If 'word2' is specified it compares 'word' and 'word2' to check if they are anagrams of each other.\n"
  40     "Options:\n"
  41     "-h \t Show this help\n"
  42     "-m \t Find multiword anagrams\n"
  43     "-p \t Checks if 'word' is a palindrome\n"
  44     "-P \t Only checks if 'word' is a palindrome. Does not find angrams.\n\n"
  45     "Example:\n"
  46     "\t anagram -p cat\n\n"
  47     "Website: http://code.agnibho.com/anagram/"
  48       <<endl;
  49   return true;
  50 }
  51
  52 #endif //HELP