Darcs.Arguments

get_content returns the content of a flag, if any. For instance, the content of Author "Louis Aragon" is StringContent "Louis Aragon", while the content of Pipe is NoContent

get_content :: DarcsFlag -> Maybe String

isa :: DarcsFlag -> (String -> DarcsFlag) -> Bool

a `'isa'` b tests whether a is flag b with a string argument. b typically is a Flag constructor expecting a string For example, (Author "Ted Hughes") isa Author returns true.

isAnAbsolute :: DarcsFlag -> (AbsolutePath -> DarcsFlag) -> Bool

a `'isAnAbsolute'` b tests whether a is flag b with an absolute path argument. b typically is a Flag constructor expecting an absolute path argument For example, (Context contextfile) isAnAbsolute Context returns true.

isAnAbsoluteOrStd :: DarcsFlag -> (AbsolutePathOrStd -> DarcsFlag) -> Bool

a `'isAnAbsoluteOrStd'` b tests whether a is flag b with a path argument. b typically is a Flag constructor expecting a path argument For example, (Output o) isAnAbsoluteOrStd returns true.

isin :: (String -> DarcsFlag) -> [DarcsFlag] -> Bool

arein :: [DarcsOption] -> [DarcsFlag] -> Bool

data DarcsOption

A type for darcs' options. The value contains the command line switch(es) for the option, a help string, and a function to build a DarcsFlag from the command line arguments. for each constructor, shortSwitches represents the list of short command line switches which invoke the option, longSwitches the list of long command line switches, optDescr the description of the option, and argDescr the description of its argument, if any. mkFlag is a function which makes a DarcsFlag from the arguments of the option.

Constructors

DarcsArgOption [Char] [String] (String -> DarcsFlag) String String	`DarcsArgOption shortSwitches longSwitches mkFlag ArgDescr OptDescr` The constructor for options with a string argument, such as `--tag`
DarcsAbsPathOption [Char] [String] (AbsolutePath -> DarcsFlag) String String	`DarcsAbsPathOption shortSwitches longSwitches mkFlag ArgDescr OptDescr` The constructor for options with an absolute path argument, such as `--sibling`
DarcsAbsPathOrStdOption [Char] [String] (AbsolutePathOrStd -> DarcsFlag) String String	`DarcsAbsPathOrStdOption shortSwitches longSwitches mkFlag ArgDescr OptDescr` The constructor for options with a path argument, such as `-o`
DarcsOptAbsPathOption [Char] [String] String (AbsolutePath -> DarcsFlag) String String	`DarcsOptAbsPathOrStdOption shortSwitches longSwitches defaultPath mkFlag ArgDescr OptDescr` where defaultPath is a default value for the Path, as a string to be parsed as if it had been given on the command line. The constructor for options with an optional path argument, such as `-O`
DarcsNoArgOption [Char] [String] DarcsFlag String	`DarcsNoArgOption shortSwitches longSwitches mkFlag optDescr` The constructon fon options with no arguments.
DarcsMultipleChoiceOption [DarcsOption]	A constructor for grouping related options together, such as `--hashed`, `--darcs-2` and `--old-fashioned-inventory`.

option_from_darcsoption :: AbsolutePath -> DarcsOption -> [OptDescr DarcsFlag]

concat_options :: [DarcsOption] -> DarcsOption

concat_option creates a DarcsMultipleChoiceOption from a list of option, flattening any DarcsMultipleChoiceOption in the list.

extract_fix_path :: [DarcsFlag] -> Maybe (AbsolutePath, AbsolutePath)

fixFilePath :: [DarcsFlag] -> FilePath -> IO AbsolutePath

fixFilePathOrStd :: [DarcsFlag] -> FilePath -> IO AbsolutePathOrStd

fixUrl :: [DarcsFlag] -> String -> IO String

fixSubPaths :: [DarcsFlag] -> [FilePath] -> IO [SubPath]

partitionEither :: [Either a b] -> ([b], [a])

areFileArgs :: [SubPath] -> Bool

list_options :: DarcsOption

list_option is an option which lists the command's arguments

flagToString :: [DarcsOption] -> DarcsFlag -> Maybe String

reponame :: DarcsOption

tagname :: DarcsOption

deps_sel :: DarcsOption

checkpoint :: DarcsOption

partial :: DarcsOption

partial_check :: DarcsOption

tokens :: DarcsOption

working_repo_dir :: DarcsOption

possibly_remote_repo_dir :: DarcsOption

disable :: DarcsOption

restrict_paths :: DarcsOption

all_pipe_interactive :: DarcsOption

all_interactive :: DarcsOption

all_patches :: DarcsOption

interactive :: DarcsOption

pipe :: DarcsOption

human_readable :: DarcsOption

diffflags :: DarcsOption

allow_problematic_filenames :: DarcsOption

noskip_boring :: DarcsOption

ask_long_comment :: DarcsOption

match_one_nontag :: DarcsOption

changes_reverse :: DarcsOption

creatorhash :: DarcsOption

changes_format :: DarcsOption

match_one_context :: DarcsOption

happy_forwarding :: DarcsOption

send_to_context :: DarcsOption

diff_cmd_flag :: DarcsOption

store_in_memory :: DarcsOption

use_external_merge :: DarcsOption

pull_conflict_options :: DarcsOption

target :: DarcsOption

cc :: DarcsOption

apply_conflict_options :: DarcsOption

reply :: DarcsOption

xmloutput :: DarcsOption

distname_option :: DarcsOption

patchname_option :: DarcsOption

edit_description :: DarcsOption

output :: DarcsOption

output_auto_name :: DarcsOption

unidiff :: DarcsOption

repo_combinator :: DarcsOption

unified :: DarcsOption

summary :: DarcsOption

uncompress_nocompress :: DarcsOption

subject :: DarcsOption

in_reply_to :: DarcsOption

nocompress :: DarcsOption

match_several_or_range :: DarcsOption

match_several_or_last :: DarcsOption

author :: DarcsOption

askdeps :: DarcsOption

lookforadds :: DarcsOption

ignoretimes :: DarcsOption

test :: DarcsOption

notest :: DarcsOption

help :: DarcsOption

force_replace :: DarcsOption

allow_unrelated_repos :: DarcsOption

match_one :: DarcsOption

match_range :: DarcsOption

match_several :: DarcsOption

fancy_move_add :: DarcsOption

sendmail_cmd :: DarcsOption

logfile :: DarcsOption

rmlogfile :: DarcsOption

leave_test_dir :: DarcsOption

from_opt :: DarcsOption

set_default :: DarcsOption

pipe_interactive :: DarcsOption

recursive :: String -> DarcsOption

applyas :: DarcsOption

verify :: DarcsOption

sign :: DarcsOption

any_verbosity :: [DarcsOption]

get_repourl :: [DarcsFlag] -> Maybe String

get_repourl takes a list of flags and returns the url of the repository specified by Repodir "directory" in that list of flags, if any. This flag is present if darcs was invoked with --repodir=DIRECTORY

remote_repo :: DarcsOption

remote_repo is the option used to specify the URL of the remote repository to work with

match_from :: DarcsOption

match_to :: DarcsOption

__tags :: DarcsOption

__patch :: DarcsOption

__patches :: DarcsOption

__match :: DarcsOption

__matches :: DarcsOption

__last :: DarcsOption

__index :: DarcsOption

__indexes :: DarcsOption

__tag :: DarcsOption

match_maxcount :: DarcsOption

get_context :: [DarcsFlag] -> Maybe AbsolutePath

get_context takes a list of flags and returns the context specified by Context c in that list of flags, if any. This flag is present if darcs was invoked with --context=FILE

testByDefault :: [DarcsFlag] -> [DarcsFlag]

get_author :: [DarcsFlag] -> IO String

get_author takes a list of flags and returns the author of the change specified by Author "Leo Tolstoy" in that list of flags, if any. Otherwise, if Pipe is present, asks the user who is the author and returns the answer. If neither are present, try to guess the author, from _darcs/prefs, and if it's not possible, ask the user.

get_easy_author :: IO (Maybe String)

get_easy_author tries to get the author name first from the repository preferences, then from global preferences, then from environment variables. Returns Nothing if it could not get it.

__dont_compress :: DarcsOption

__uncompress :: DarcsOption

__compress :: DarcsOption

get_cc :: [DarcsFlag] -> String

get_cc takes a list of flags and returns the addresses to send a copy of the patch bundle to when using darcs send. looks for a cc address specified by Cc "address" in that list of flags. Returns the addresses as a comma separated string.

get_subject :: [DarcsFlag] -> Maybe String

get_subject takes a list of flags and returns the subject of the mail to be sent by darcs send. Looks for a subject specified by Subject "subject" in that list of flags, if any. This flag is present if darcs was invoked with --subject=SUBJECT

get_in_reply_to :: [DarcsFlag] -> Maybe String

inventory_choices :: DarcsOption

get_inventory_choices :: DarcsOption

__lazy :: DarcsOption

__ephemeral :: DarcsOption

__complete :: DarcsOption

__partial :: DarcsOption

dry_run_noxml :: DarcsOption

dry_run :: [DarcsOption]

showFriendly :: Patchy p => [DarcsFlag] -> p -> Doc

showFriendly flags patch returns a Doc representing the right way to show patch given the list flags of flags darcs was invoked with.

print_dry_run_message_and_exit :: RepoPatch p => String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO ()

print_dry_run_message_and_exit action opts patches prints a string representing the action that would be taken if the --dry-run option had not been passed to darcs. Then darcs exits successfully. action is the name of the action being taken, like "push" opts is the list of flags which were sent to darcs patches is the sequence of patches which would be touched by action.

only_to_files :: DarcsOption

list_files :: IO [String]

list_files returns the list of all non-boring files in the repository

drop_dotslash :: String -> String

list_unregistered_files :: IO [String]

list_unregistered_files returns the list of all non-boring unregistered files in the repository.

list_registered_files :: IO [String]

list_registered_files returns the list of all registered files in the repository.

options_latex :: [DarcsOption] -> String

latex_help :: String -> String

option_latex :: DarcsOption -> String

show_short_options :: [Char] -> String

show_long_options :: [String] -> String

set_scripts_executable :: DarcsOption

relink_pristine :: DarcsOption

sibling :: DarcsOption

relink :: DarcsOption

flagsToSiblings :: [DarcsFlag] -> [AbsolutePath]

flagsToSiblings collects the contents of all Sibling flags in a list of flags.

nolinks :: DarcsOption

reorder_patches :: DarcsOption

environmentHelpSendmail :: ([String], [String])

sendmail(8) is not sendmail-specific;

nowadays, desktops often have no MTA or an unconfigured MTA --

in this case, can be a sendmail(8)-emulating wrapper on top of an

on a multi-user system without an MTA and on which you haven't

get_sendmail_cmd :: [DarcsFlag] -> IO String

get_sendmail_cmd takes a list of flags and returns the sendmail command to be used by darcs send. Looks for a command specified by SendmailCmd "command" in that list of flags, if any. This flag is present if darcs was invoked with --sendmail-command=COMMAND Alternatively the user can set $SENDMAIL which will be used as a fallback if present.

files :: DarcsOption

directories :: DarcsOption

pending :: DarcsOption

nullFlag :: DarcsOption

definePatches :: RepoPatch p => FL (PatchInfoAnd p) -> IO ()

setEnvCautiously :: String -> String -> IO ()

defineChanges :: Patchy p => p -> IO ()

posthook_cmd :: DarcsOption

posthook_prompt :: DarcsOption

get_posthook_cmd :: [DarcsFlag] -> Maybe String

get_posthook_cmd takes a list of flags and returns the posthook command specified by PosthookCmd a in that list of flags, if any.

prehook_cmd :: DarcsOption

prehook_prompt :: DarcsOption

get_prehook_cmd :: [DarcsFlag] -> Maybe String

get_prehook_cmd takes a list of flags and returns the prehook command specified by PrehookCmd a in that list of flags, if any.

network_options :: [DarcsOption]

no_cache :: DarcsOption

umask_option :: DarcsOption

patch_select_flag :: DarcsFlag -> Bool

patch_select_flag f holds whenever f is a way of selecting patches such as PatchName n.

number_string :: String -> Int

The integer corresponding to a string, if it's only composed of digits. Otherwise, -1.

Produced by Haddock version 2.4.2