workbench/c/shellcommands/Prompt.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Prompt CLI command
   6     Lang: English
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME
  12
  13         Prompt
  14
  15     SYNOPSIS
  16
  17         PROMPT
  18
  19     LOCATION
  20
  21         C:
  22
  23     FUNCTION
  24
  25         Specify the prompt for the current shell.
  26
  27     INPUTS
  28
  29         PROMPT  --  The prompt to set as a string. The following commands
  30                     may be used in a printf kind of style.
  31
  32                     N  --  cli number
  33                     S  --  name of the current directory
  34                     R  --  return code of the last operation
  35
  36                     If no prompt is specified "%N.%S> " is used as default.
  37
  38     RESULT
  39
  40         Standard DOS return codes.
  41
  42     NOTES
  43
  44     EXAMPLE
  45
  46         Prompt "Oepir Risti.%N> " gives:
  47
  48         Oepir Risti.10>      (if the CLI number was 10)
  49
  50     BUGS
  51
  52     SEE ALSO
  53
  54         dos.library/SetPrompt()
  55
  56     INTERNALS
  57
  58     HISTORY
  59
  60         16-12-99   SDuvan   Implemented
  61
  62 ******************************************************************************/
  63
  64 #include <dos/dos.h>
  65 #include <dos/dosextens.h>
  66 #include <proto/dos.h>
  67
  68 #include <aros/shcommands.h>
  69
  70 AROS_SH1(Prompt,41.1,
  71 AROS_SHA(STRPTR, ,PROMPT, , "%N.%S> "))
  72 {
  73     AROS_SHCOMMAND_INIT
  74
  75
  76     if (SetPrompt(SHArg(PROMPT)) == DOSFALSE)
  77     {
  78         PrintFault(IoErr(), "Prompt");
  79
  80         return RETURN_ERROR;
  81     }
  82
  83     return RETURN_OK;
  84
  85     AROS_SHCOMMAND_EXIT
  86 }
  87