mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/CmdLine/Usage.hs

113 lines
2.6 KiB
Haskell
Raw Normal View History

per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
{- git-annex usage messages
-
convert all commands to work with optparse-applicative Still no options though.
2015-07-08 19:08:02 +00:00
- Copyright 2010-2015 Joey Hess <id@joeyh.name>
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
-
update licenses from GPL to AGPL This does not change the overall license of the git-annex program, which was already AGPL due to a number of sources files being AGPL already. Legally speaking, I'm adding a new license under which these files are now available; I already released their current contents under the GPL license. Now they're dual licensed GPL and AGPL. However, I intend for all my future changes to these files to only be released under the AGPL license, and I won't be tracking the dual licensing status, so I'm simply changing the license statement to say it's AGPL. (In some cases, others wrote parts of the code of a file and released it under the GPL; but in all cases I have contributed a significant portion of the code in each file and it's that code that is getting the AGPL license; the GPL license of other contributors allows combining with AGPL code.)
2019-03-13 19:48:14 +00:00
- Licensed under the GNU AGPL version 3 or higher.
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
-}
reorganize some files and imports
2014-01-26 20:25:55 +00:00
module CmdLine.Usage where
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
remove 163 lines of code without changing anything except imports
2016-01-20 20:36:33 +00:00
import Annex.Common
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
import Types.Command
Per-command usage messages.
2013-03-27 17:51:24 +00:00
usageMessage :: String -> String
usageMessage s = "Usage: " ++ s
make usage less terrifying Need to make `git annex help command` show the options for that command.
2013-03-25 16:41:57 +00:00
usage :: String -> [Command] -> String
let optparse-applicative handle the usage display when run w/o command or bad command Still generating the list of commands myself, to get it sorted into sections and with short synopses.
2015-07-09 15:49:52 +00:00
usage header cmds = unlines $ usageMessage header : commandList cmds
improve synopsis
2020-12-17 16:51:49 +00:00
{- Commands listed by section, with brief usage and description. -}
let optparse-applicative handle the usage display when run w/o command or bad command Still generating the list of commands myself, to get it sorted into sections and with short synopses.
2015-07-09 15:49:52 +00:00
commandList :: [Command] -> [String]
commandList cmds = concatMap go [minBound..]
more indentation. must stop.
2012-10-29 02:09:09 +00:00
where
make usage less terrifying Need to make `git annex help command` show the options for that command.
2013-03-25 16:41:57 +00:00
go section
| null cs = []
| otherwise =
[ ""
, descSection section ++ ":"
, ""
] ++ map cmdline cs
more indentation. must stop.
2012-10-29 02:09:09 +00:00
where
make usage less terrifying Need to make `git annex help command` show the options for that command.
2013-03-25 16:41:57 +00:00
cs = filter (\c -> cmdsection c == section) scmds
cmdline c = concat
[ cmdname c
, namepad (cmdname c)
, cmdparamdesc c
, descpad (cmdparamdesc c)
, cmddesc c
]
more indentation. must stop.
2012-10-29 02:09:09 +00:00
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
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
let optparse-applicative handle the usage display when run w/o command or bad command Still generating the list of commands myself, to get it sorted into sections and with short synopses.
2015-07-09 15:49:52 +00:00
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
{- Descriptions of params used in usage messages. -}
paramPaths :: String
display cmdparamdesc in optparse-applicative usage messages Since optparse-applicative display "FOO" as "[FOO]", the paramOptional modifier which wrapped it in square brackets was removed from most places.
2015-07-08 17:39:11 +00:00
paramPaths = paramRepeating paramPath -- most often used
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramPath :: String
paramPath = "PATH"
paramKey :: String
paramKey = "KEY"
paramDesc :: String
paramDesc = "DESC"
paramUrl :: String
paramUrl = "URL"
paramNumber :: String
paramNumber = "NUMBER"
addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.
2012-05-02 18:59:05 +00:00
paramNumRange :: String
paramNumRange = "NUM|RANGE"
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramRemote :: String
paramRemote = "REMOTE"
fix typo
2022-10-07 16:30:07 +00:00
paramRepository :: String
paramRepository = "REPOSITORY"
metadata: Add --get (from bremner)
2014-03-15 21:29:40 +00:00
paramField :: String
paramField = "FIELD"
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramGlob :: String
paramGlob = "GLOB"
paramName :: String
paramName = "NAME"
more command-specific options Made --from and --to command-specific options. Added generic storage for values of command-specific options, which allows removing some of the special case fields in AnnexState. (Also added generic storage for command-specific flags, although there are not yet any.) Note that this storage uses a Map, so repeatedly looking up the same value is slightly more expensive than looking up an AnnexState field. But, the value can be looked up once in the seek stage, transformed as necessary, and passed in a closure to the start stage, and this avoids that overhead. Still, I'm hesitant to use this for things like force or fast flags. It's probably best to reserve it for flags that are only used by a few commands, or options like --from and --to that it's important only be allowed to be used with commands that implement them, to avoid user confusion.
2012-01-06 07:06:25 +00:00
paramValue :: String
paramValue = "VALUE"
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramUUID :: String
paramUUID = "UUID"
paramType :: String
paramType = "TYPE"
log --after=date
2012-01-06 21:24:03 +00:00
paramDate :: String
log --before=date
2012-01-07 01:27:42 +00:00
paramDate = "DATE"
New --time-limit option, makes long git-annex commands stop after a specified amount of time.
2012-09-25 20:48:24 +00:00
paramTime :: String
paramTime = "TIME"
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramFormat :: String
paramFormat = "FORMAT"
addurl: Added a --file option Can be used to specify what file the url is added to. This can be used to override the default filename that is used when adding an url, which is based on the url. Or, when the file already exists, the url is recorded as another location of the file.
2012-02-08 19:35:18 +00:00
paramFile :: String
paramFile = "FILE"
findref: New command, like find but shows files in a specified git ref.
2014-04-17 22:41:24 +00:00
paramRef :: String
paramRef = "REF"
unused: Add --used option, which can specify a set of refs to consider used, rather than the default of considering all refs used.
2015-05-14 19:31:38 +00:00
paramRefSpec :: String
paramRefSpec = "REFSPEC"
group, ungroup: New commands to indicate groups of repositories.
2012-10-01 19:12:04 +00:00
paramGroup :: String
paramGroup = "GROUP"
content: New command line way to view and configure a repository's preferred content settings.
2013-05-25 16:44:58 +00:00
paramExpression :: String
paramExpression = "EXPR"
add --ingroup limit
2012-10-08 19:18:58 +00:00
paramSize :: String
paramSize = "SIZE"
webapp: New --listen= option allows running the webapp on one computer and connecting to it from another. Does not yet use HTTPS. I'd need to generate a certificate, and I'm not sure what's the best way to do that.
2013-04-08 19:04:35 +00:00
paramAddress :: String
paramAddress = "ADDRESS"
info: When passed the name or uuid of a remote, displays info about that remote. No per-remote-type info yet. This commit was sponsored by Stanley Yamane.
2014-10-21 17:44:17 +00:00
paramItem :: String
paramItem = "ITEM"
initial export command Very basic operation works, but of course this is only the beginning. This commit was sponsored by Nick Daly on Patreon.
2017-08-29 18:58:38 +00:00
paramTreeish :: String
paramTreeish = "TREEISH"
initremote --describe-other-params Does not yet include descriptions from external special remote programs.
2020-01-20 20:05:51 +00:00
paramParamValue :: String
paramParamValue = "PARAM=VALUE"
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramNothing :: String
paramNothing = ""
paramRepeating :: String -> String
paramRepeating s = s ++ " ..."
paramOptional :: String -> String
display cmdparamdesc in optparse-applicative usage messages Since optparse-applicative display "FOO" as "[FOO]", the paramOptional modifier which wrapped it in square brackets was removed from most places.
2015-07-08 17:39:11 +00:00
paramOptional s = s
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
paramPair :: String -> String -> String
paramPair a b = a ++ " " ++ b
reinject: Added new mode which can reinject known files into the annex. For example: git-annex reinject --known /mnt/backup/*
2016-04-22 17:49:32 +00:00
paramOr :: String -> String -> String
paramOr a b = a ++ " | " ++ b
Reference in a new issue Copy permalink