diff --git a/Shellac.cabal b/Shellac.cabal index ce45681..792dbdf 100644 --- a/Shellac.cabal +++ b/Shellac.cabal @@ -8,7 +8,7 @@ Author: Robert Dockins Maintainer: robdockins AT fastmail DOT fm Category: User Interfaces Stability: Beta -Synopsis: A framework for creating shell envinronments +Synopsis: A framework for creating shell environments Homepage: http://rwd.rdockins.name/shellac/home/ Description: Shellac is a framework for building read-eval-print style shells. diff --git a/home/index.html b/home/index.html index d60f40d..6b4b15c 100644 --- a/home/index.html +++ b/home/index.html @@ -64,7 +64,7 @@

Documentation

To see examples of using Shellac, you can check out the lambda shell, which I wrote partially as a way to exercise most of Shellac's features. -For a more mimimal example, check out Andy Gimblett's blog, where he shows +For a more minimal example, check out Andy Gimblett's blog, where he shows how to build a simple shell using Shellac in about 130 (commented!) lines of code.

diff --git a/shellac-compatline/Shellac-compatline.cabal b/shellac-compatline/Shellac-compatline.cabal index ee2b304..53a0519 100644 --- a/shellac-compatline/Shellac-compatline.cabal +++ b/shellac-compatline/Shellac-compatline.cabal @@ -13,7 +13,7 @@ Synopsis: "compatline" backend module for Shellac Description: This package provides a Shellac backend which acts a thin interface for the Shellac-readline or Shellac-editline packages, depending - on avaliability. Note that this package may be compiled against + on availability. Note that this package may be compiled against readline, which is licended under the GPL. Source-repository head @@ -22,7 +22,7 @@ Source-repository head subdir: shellac-compatline Flag UseEditline - Description: Use the Shellac-editline pacakge + Description: Use the Shellac-editline package Default: False Flag UseReadline diff --git a/shellac-compatline/src/System/Console/Shell/Backend/Compatline.hs b/shellac-compatline/src/System/Console/Shell/Backend/Compatline.hs index f0b5491..7031fcb 100644 --- a/shellac-compatline/src/System/Console/Shell/Backend/Compatline.hs +++ b/shellac-compatline/src/System/Console/Shell/Backend/Compatline.hs @@ -6,15 +6,15 @@ {- | This module implements a Shellac backend based either on GNU readline or on libedit. The choice between these two - packages is made at compile time, based on avaliability. In the case that - both are avaliable, libedit is chosen. + packages is made at compile time, based on availability. In the case that + both are available, libedit is chosen. Beware that while the code for this Shellac binding is licensed under a BSD3 license, GNU readline itself is licensed under the GPL. This means that your project needs to be GPL compatible to use this backend! Otherwise you may encounter licensing issues. - If your project is not GPL compatabile you should instead use the Shellac-editline + If your project is not GPL compatible you should instead use the Shellac-editline library, as editline is licensed under a BSD3 license. -} diff --git a/src/System/Console/Shell/Backend.hs b/src/System/Console/Shell/Backend.hs index a286a54..2582f38 100644 --- a/src/System/Console/Shell/Backend.hs +++ b/src/System/Console/Shell/Backend.hs @@ -39,7 +39,7 @@ module System.Console.Shell.Backend type CompletionFunction = (String,String,String) -> IO (Maybe (String, [String])) --- | A datatype representing ouput to be printed. The different categories of +-- | A datatype representing output to be printed. The different categories of -- output are distinguished to that shell backends can, for example, apply -- different colors or send output to different places (stderr versus stdout). @@ -137,7 +137,7 @@ defaultWordBreakChars = " \t\n\r\v`~!@#$%^&*()=[]{};\\\'\",<>" -- | This backend template is useful for defining custom backends. -- The idea is that you will use 'templateBackend' to generate a --- bare-bones backend implemenation and only fill in the methods +-- bare-bones backend implementation and only fill in the methods -- that you wish to define using the record update syntax. -- The parameter to 'templateBackend' -- becomes the backend state associated with the backend and is diff --git a/src/System/Console/Shell/Commands.hs b/src/System/Console/Shell/Commands.hs index 3a6d946..c35ac03 100644 --- a/src/System/Console/Shell/Commands.hs +++ b/src/System/Console/Shell/Commands.hs @@ -62,7 +62,7 @@ class Completion compl st | compl -> st where ----------------------------------------------------------------------- --- | Prints the help message for this shell, which lists all avaliable +-- | Prints the help message for this shell, which lists all available -- commands with their syntax and a short informative message about each. showShellHelp :: ShellDescription st -> String @@ -134,7 +134,7 @@ toggle name helpMsg getter setter desc = else shellPutInfoLn (name++" on") >> putShellSt (setter True st) ------------------------------------------------------------------- --- | Creates a user defined shell commmand. This relies on the +-- | Creates a user defined shell command. This relies on the -- typeclass machenery defined by 'CommandFunction'. cmd :: CommandFunction f st => String -- ^ the name of the command @@ -153,7 +153,7 @@ cmd name f helpMsg desc = ------------------------------------------------------------------------------ --- | This class is used in the 'cmd' function to automaticly generate +-- | This class is used in the 'cmd' function to automatically generate -- the command parsers and command syntax strings for user defined -- commands. The type of \'f\' is restricted to have a restricted set of -- monomorphic arguments ('Int', 'Integer', 'Float', 'Double', 'String', diff --git a/src/System/Console/Shell/Regex.hs b/src/System/Console/Shell/Regex.hs index 1156b2f..2540a09 100644 --- a/src/System/Console/Shell/Regex.hs +++ b/src/System/Console/Shell/Regex.hs @@ -8,7 +8,7 @@ - They are used to parse the arguments to shell commands and to give - information about the type of the argument at a position in the - string to allow positional word completion. The REs are directly - - interpreted in the list monad, so effeciency isn't so great, but + - interpreted in the list monad, so efficiency isn't so great, but - for most shell command lines that won't matter too much. -} @@ -44,7 +44,7 @@ data RegexContext deriving Eq {- Print a string representation of a regular expression. - Really only useful for debugging becuase there is no + Really only useful for debugging because there is no inverse (parser). -} showRegex :: RegexContext -> Regex a x -> String diff --git a/src/System/Console/Shell/RunShell.hs b/src/System/Console/Shell/RunShell.hs index f11735e..6c818f3 100644 --- a/src/System/Console/Shell/RunShell.hs +++ b/src/System/Console/Shell/RunShell.hs @@ -317,7 +317,7 @@ shellLoop desc backend iss = loop ------------------------------------------------------------------------- -- | The default shell exception handler. It simply prints the exception --- and returns the shell state unchanged. (However, it specificaly +-- and returns the shell state unchanged. (However, it specifically -- ignores the thread killed exception, because that is used to -- implement execution canceling) diff --git a/src/System/Console/Shell/ShellMonad.hs b/src/System/Console/Shell/ShellMonad.hs index 10dc962..3b03165 100644 --- a/src/System/Console/Shell/ShellMonad.hs +++ b/src/System/Console/Shell/ShellMonad.hs @@ -80,7 +80,7 @@ getShellSt = Sh (get >>= return . fst) putShellSt :: st -> Sh st () putShellSt st = Sh (get >>= \ (_,spec) -> put (st,spec)) --- | Apply the given funtion to the shell state +-- | Apply the given function to the shell state modifyShellSt :: (st -> st) -> Sh st () modifyShellSt f = getShellSt >>= putShellSt . f diff --git a/src/System/Console/Shell/Types.hs b/src/System/Console/Shell/Types.hs index deb5b5e..2244627 100644 --- a/src/System/Console/Shell/Types.hs +++ b/src/System/Console/Shell/Types.hs @@ -19,7 +19,7 @@ import System.Console.Shell.Backend -- determines how shell input is parsed. data CommandStyle = OnlyCommands -- ^ Indicates that all input is to be interpreted as shell commands; - -- input is only passed to the evaluation fuction if it cannot be + -- input is only passed to the evaluation function if it cannot be -- parsed as a command. | CharPrefixCommands Char -- ^ Indicates that commands are prefixed with a particular character. -- Colon \':\' is the default character (a la GHCi).