diff options
author | Joey Hess <joey@kitenet.net> | 2014-01-26 16:25:55 -0400 |
---|---|---|
committer | Joey Hess <joey@kitenet.net> | 2014-01-26 16:25:55 -0400 |
commit | 4f050ca9b80d0565e408137f2422e808b82cfd11 (patch) | |
tree | 5aca9688e49dee8915a962de4baf4c305ccbfa9e /Usage.hs | |
parent | 541178b499d084e4041ae4b9d62bf86f5a97c3ff (diff) |
reorganize some files and imports
Diffstat (limited to 'Usage.hs')
-rw-r--r-- | Usage.hs | 111 |
1 files changed, 0 insertions, 111 deletions
diff --git a/Usage.hs b/Usage.hs deleted file mode 100644 index 9a48a0908..000000000 --- a/Usage.hs +++ /dev/null @@ -1,111 +0,0 @@ -{- git-annex usage messages - - - - Copyright 2010-2011 Joey Hess <joey@kitenet.net> - - - - Licensed under the GNU GPL version 3 or higher. - -} - -module Usage where - -import Common.Annex - -import Types.Command - -import System.Console.GetOpt - -usageMessage :: String -> String -usageMessage s = "Usage: " ++ s - -{- Usage message with lists of commands by section. -} -usage :: String -> [Command] -> String -usage header cmds = unlines $ usageMessage header : concatMap go [minBound..] - where - go section - | null cs = [] - | otherwise = - [ "" - , descSection section ++ ":" - , "" - ] ++ map cmdline cs - where - cs = filter (\c -> cmdsection c == section) scmds - cmdline c = concat - [ cmdname c - , namepad (cmdname c) - , cmdparamdesc c - , descpad (cmdparamdesc c) - , cmddesc c - ] - pad n s = replicate (n - length s) ' ' - namepad = pad $ longest cmdname + 1 - descpad = pad $ longest cmdparamdesc + 2 - longest f = foldl max 0 $ map (length . f) cmds - scmds = sort cmds - -{- Usage message for a single command. -} -commandUsage :: Command -> String -commandUsage cmd = unlines - [ usageInfo header (cmdoptions cmd) - , "To see additional options common to all commands, run: git annex help options" - ] - where - header = usageMessage $ unwords - [ "git-annex" - , cmdname cmd - , cmdparamdesc cmd - , "[option ...]" - ] - -{- Descriptions of params used in usage messages. -} -paramPaths :: String -paramPaths = paramOptional $ paramRepeating paramPath -- most often used -paramPath :: String -paramPath = "PATH" -paramKey :: String -paramKey = "KEY" -paramDesc :: String -paramDesc = "DESC" -paramUrl :: String -paramUrl = "URL" -paramNumber :: String -paramNumber = "NUMBER" -paramNumRange :: String -paramNumRange = "NUM|RANGE" -paramRemote :: String -paramRemote = "REMOTE" -paramGlob :: String -paramGlob = "GLOB" -paramName :: String -paramName = "NAME" -paramValue :: String -paramValue = "VALUE" -paramUUID :: String -paramUUID = "UUID" -paramType :: String -paramType = "TYPE" -paramDate :: String -paramDate = "DATE" -paramTime :: String -paramTime = "TIME" -paramFormat :: String -paramFormat = "FORMAT" -paramFile :: String -paramFile = "FILE" -paramGroup :: String -paramGroup = "GROUP" -paramExpression :: String -paramExpression = "EXPR" -paramSize :: String -paramSize = "SIZE" -paramAddress :: String -paramAddress = "ADDRESS" -paramKeyValue :: String -paramKeyValue = "K=V" -paramNothing :: String -paramNothing = "" -paramRepeating :: String -> String -paramRepeating s = s ++ " ..." -paramOptional :: String -> String -paramOptional s = "[" ++ s ++ "]" -paramPair :: String -> String -> String -paramPair a b = a ++ " " ++ b |