{ "content": [ { "type": "text", "text": "# DARCS(1) (man)\n\n**Summary:** darcs - an advanced revision control system\n\n**Synopsis:** darcs command ...\nWhere the commands and their respective arguments are\ndarcs help [ [darcssubcommand]]\ndarcs initialize []\ndarcs add ...\ndarcs whatsnew [file|directory]...\ndarcs record [file|directory]...\ndarcs clone []\ndarcs pull [repository]...\ndarcs push [repository]\ndarcs move ... \ndarcs remove ...\ndarcs replace ...\ndarcs log [file|directory]...\ndarcs annotate [file|directory]\ndarcs diff [file|directory]...\ndarcs show contents [file]...\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (19 lines) — 27 subsections\n - darcs show dependencies (1 lines)\n - darcs show index (1 lines)\n - darcs show pristine (1 lines)\n - darcs show repo (1 lines)\n - darcs show authors (1 lines)\n - darcs show tags (1 lines)\n - darcs show patch-index (2 lines)\n - darcs unrevert (3 lines)\n - darcs rebase suspend (1 lines)\n - darcs rebase unsuspend (1 lines)\n - darcs rebase obliterate (1 lines)\n - darcs rebase log (1 lines)\n - darcs unrecord (1 lines)\n - darcs obliterate (4 lines)\n - darcs optimize clean (1 lines)\n - darcs optimize http (1 lines)\n - darcs optimize reorder (1 lines)\n - darcs optimize enable-patch-index (1 lines)\n - darcs optimize disable-patch-index (1 lines)\n - darcs optimize compress (1 lines)\n - darcs optimize uncompress (1 lines)\n - darcs optimize relink (1 lines)\n - darcs optimize pristine (1 lines)\n - darcs optimize upgrade (1 lines)\n - darcs dist (1 lines)\n - darcs repair (1 lines)\n - darcs convert export (4 lines)\n- **DESCRIPTION** (14 lines)\n- **OPTIONS** (4 lines) — 1 subsections\n - Selecting Patches: (42 lines)\n- **COMMANDS** (6 lines) — 34 subsections\n - Most used/starting out: (213 lines)\n - Preparing patches before recording: (70 lines)\n - Querying the repository: (68 lines)\n - darcs show dependencies (27 lines)\n - darcs show index (3 lines)\n - darcs show pristine (3 lines)\n - darcs show repo (15 lines)\n - darcs show authors (33 lines)\n - darcs show tags (5 lines)\n - darcs show patch-index (27 lines)\n - Undoing and correcting: (11 lines)\n - darcs unrevert (35 lines)\n - darcs rebase suspend (2 lines)\n - darcs rebase unsuspend (2 lines)\n - darcs rebase obliterate (2 lines)\n - darcs rebase log (13 lines)\n - darcs unrecord (5 lines)\n - darcs obliterate (8 lines)\n - Direct modification of the repository: (45 lines)\n - Exchanging patches by e-mail: (126 lines)\n - Other commands: (1 lines)\n - darcs optimize clean (1 lines)\n - darcs optimize http (4 lines)\n - darcs optimize reorder (3 lines)\n - darcs optimize enable-patch-index (2 lines)\n - darcs optimize disable-patch-index (1 lines)\n - darcs optimize compress (8 lines)\n - darcs optimize uncompress (8 lines)\n - darcs optimize relink (7 lines)\n - darcs optimize pristine (2 lines)\n - darcs optimize upgrade (9 lines)\n - darcs dist (36 lines)\n - darcs repair (20 lines)\n - darcs convert export (50 lines)\n- **ENVIRONMENT** (1 lines) — 1 subsections\n - HOME and APPDATA (159 lines)\n- **FILES** (134 lines)\n- **BUGS** (4 lines)\n- **SEE ALSO** (3 lines)\n- **LICENSE** (7 lines)\n\n## Full Content\n\n### NAME\n\ndarcs - an advanced revision control system\n\n### SYNOPSIS\n\ndarcs command ...\n\nWhere the commands and their respective arguments are\n\ndarcs help [ [darcssubcommand]]\ndarcs initialize []\ndarcs add ...\ndarcs whatsnew [file|directory]...\ndarcs record [file|directory]...\ndarcs clone []\ndarcs pull [repository]...\ndarcs push [repository]\ndarcs move ... \ndarcs remove ...\ndarcs replace ...\ndarcs log [file|directory]...\ndarcs annotate [file|directory]\ndarcs diff [file|directory]...\ndarcs show contents [file]...\n\n#### darcs show dependencies\n\ndarcs show files [file|directory]...\n\n#### darcs show index\n\n#### darcs show pristine\n\n#### darcs show repo\n\n#### darcs show authors\n\n#### darcs show tags\n\n#### darcs show patch-index\n\ndarcs test [[initialization] command]\ndarcs revert [file|directory]...\n\n#### darcs unrevert\n\ndarcs amend [file|directory]...\ndarcs rebase pull [repository]...\ndarcs rebase apply \n\n#### darcs rebase suspend\n\n#### darcs rebase unsuspend\n\n#### darcs rebase obliterate\n\n#### darcs rebase log\n\ndarcs rollback [file|directory]...\n\n#### darcs unrecord\n\n#### darcs obliterate\n\ndarcs tag [tagname]\ndarcs setpref \ndarcs send [repository]\ndarcs apply \n\n#### darcs optimize clean\n\n#### darcs optimize http\n\n#### darcs optimize reorder\n\n#### darcs optimize enable-patch-index\n\n#### darcs optimize disable-patch-index\n\n#### darcs optimize compress\n\n#### darcs optimize uncompress\n\n#### darcs optimize relink\n\n#### darcs optimize pristine\n\n#### darcs optimize upgrade\n\ndarcs optimize cache ...\n\n#### darcs dist\n\ndarcs mark-conflicts [file|directory]...\n\n#### darcs repair\n\ndarcs convert darcs-2 []\n\n#### darcs convert export\n\ndarcs convert import []\ndarcs fetch [repository]...\n\n### DESCRIPTION\n\nDarcs is a free, open source revision control system. It is:\n\n• Distributed: Every user has access to the full command set, removing boundaries between\nserver and client or committer and non‐committers.\n\n• Interactive: Darcs is easy to learn and efficient to use because it asks you questions in\nresponse to simple commands, giving you choices in your work flow. You can choose to\nrecord one change in a file, while ignoring another. As you update from upstream, you can\nreview each patch name, even the full `diff' for interesting patches.\n\n• Smart: Originally developed by physicist David Roundy, darcs is based on a unique algebra\nof patches. This smartness lets you respond to changing demands in ways that would other‐\nwise not be possible. Learn more about spontaneous branches with darcs.\n\n### OPTIONS\n\nDifferent options are accepted by different Darcs commands. Each command's most important\noptions are listed in the COMMANDS section. For a full list of all options accepted by a\nparticular command, run `darcs command --help'.\n\n#### Selecting Patches:\n\nThe --patches option yields patches with names matching an *extended* regular expression.\nSee regex(7) for details. The --matches option yields patches that match a logical (Boolean)\nexpression: one or more primitive expressions combined by grouping (parentheses) and the com‐\nplement (not), conjunction (and) and disjunction (or) operators. The C notation for logic\noperators (!, && and ||) can also be used.\n\n- --patches=regex is a synonym for --matches='name regex' - --hash=HASH is a synonym for\n--matches='hash HASH' - --from-patch and --to-patch are synonyms for --from-match='name...\nand --to-match='name... - --from-patch and --to-match can be unproblematically combined:\n`darcs log --from-patch='html.*documentation' --to-match='date 20040212'`\n\nThe following primitive Boolean expressions are supported:\n\nexact STRING - check literal STRING is equal to patch name.\nname REGEX - match REGEX against patch name.\nauthor REGEX - match REGEX against patch author.\nhunk REGEX - match REGEX against contents of a hunk patch.\ncomment REGEX - match REGEX against the full log message.\nhash HASH - match HASH against (a prefix of) the hash of a patch.\ndate DATE - match DATE against the patch date.\ntouch REGEX - match file paths for a patch.\n\nHere are some examples:\n\ndarcs log --match 'exact \"Resolve issue17: use dynamic memory allocation.\"'\ndarcs log --match 'name issue17'\ndarcs log --match 'name \"^[Rr]esolve issue17\\>\"'\ndarcs log --match 'author \"David Roundy\"'\ndarcs log --match 'author droundy'\ndarcs log --match 'author droundy@darcs.net'\ndarcs log --match 'hunk \"foo = 2\"'\ndarcs log --match 'hunk \"^instance .* Foo where$\"'\ndarcs log --match 'comment \"prevent deadlocks\"'\ndarcs log --match 'hash c719567e92c3b0ab9eddd5290b705712b8b918ef'\ndarcs log --match 'hash c7195'\ndarcs log --match 'date \"2006-04-02 22:41\"'\ndarcs log --match 'date \"tea time yesterday\"'\ndarcs log --match 'touch src/foo.c'\ndarcs log --match 'touch src/'\ndarcs log --match 'touch \"src/*.(c|h)\"'\n\n### COMMANDS\n\ndarcs help [ [darcssubcommand]]\nWithout arguments, `darcs help` prints a categorized list of darcs commands and a short\ndescription of each one. With an extra argument, `darcs help foo` prints detailed help\nabout the darcs command foo.\n\n#### Most used/starting out:\n\ndarcs initialize []\nThe `darcs initialize` command creates an empty repository in the current directory. This\nrepository lives in a new `darcs` directory, which stores version control metadata and\nsettings.\n\nAny existing files and subdirectories become UNSAVED changes: record them with `darcs\nrecord --look-for-adds`.\n\nBy default, patches of the new repository are in the darcs-2 semantics. However it is\npossible to create a repository in darcs-1 semantics with the flag `--darcs-1`, althought\nthis is not recommended except for sharing patches with a project that uses patches in\nthe darcs-1 semantics.\n\nInitialize is commonly abbreviated to `init`.\n\ndarcs add ...\nGenerally the working tree contains both files that should be version controlled (such as\nsource code) and files that Darcs should ignore (such as executables compiled from the\nsource code). The `darcs add` command is used to tell Darcs which files to version con‐\ntrol.\n\nWhen an existing project is first imported into a Darcs repository, it is common to run\n`darcs add -r *` or `darcs record -l` to add all initial source files into darcs.\n\nAdding symbolic links (symlinks) is not supported.\n\nDarcs will ignore all files and folders that look \"boring\". The `--boring` option over‐\nrides this behaviour.\n\nDarcs will not add file if another file in the same folder has the same name, except for\ncase. The `--case-ok` option overrides this behaviour. Windows and OS X usually use\nfilesystems that do not allow files a folder to have the same name except for case (for\nexample, `ReadMe` and `README`). If `--case-ok` is used, the repository might be unus‐\nable on those systems!\n\n\ndarcs whatsnew [file|directory]...\nThe `darcs whatsnew` command lists unrecorded changes to the working tree. If you spec‐\nify a set of files and directories, only unrecorded changes to those files and directo‐\nries are listed.\n\nWith the `--summary` option, the changes are condensed to one line per file, with mnemon‐\nics to indicate the nature and extent of the change. The `--look-for-adds` option causes\ncandidates for `darcs add` to be included in the summary output. Summary mnemonics are\nas follows:\n\n* `A f` and `A d/` respectively mean an added file or directory. * `R f` and `R d/` re‐\nspectively mean a removed file or directory. * `M f -N +M rP` means a modified file,\nwith `N` lines deleted, `M`\nlines added, and `P` lexical replacements. * `f -> g` means a moved file or directory.\n* `a f` and `a d/` respectively mean a new, but unadded, file or\ndirectory, when using `--look-for-adds`.\n\nAn exclamation mark (!) as in `R! foo.c`, means the change is known to\nconflict with a change in another patch. The phrase `duplicated`\nmeans the change is known to be identical to a change in another patch.\n\nThe `--machine-readable` option implies `--summary` while making it more parsable. Modi‐\nfied files are only shown as `M f`, and moves are shown in two lines: `F f` and `T g` (as\nin 'From f To g').\n\nBy default, `darcs whatsnew` uses Darcs' internal format for changes. To see some con‐\ntext (unchanged lines) around each change, use the `--unified` option. To view changes\nin conventional `diff` format, use the `darcs diff` command; but note that `darcs what‐\nsnew` is faster.\n\nThis command exits unsuccessfully (returns a non-zero exit status) if there are no un‐\nrecorded changes.\n\ndarcs record [file|directory]...\nThe `darcs record` command is used to create a patch from changes in the working tree.\nIf you specify a set of files and directories, changes to other files will be skipped.\n\nEvery patch has a name, an optional description, an author and a date.\n\nDarcs will launch a text editor (see `darcs help environment`) after the interactive se‐\nlection, to let you enter the patch name (first line) and the patch description (subse‐\nquent lines).\n\nYou can supply the patch name in advance with the `-m` option, in which case no text edi‐\ntor is launched, unless you use `--edit-long-comment`.\n\nThe patch description is an optional block of free-form text. It is used to supply addi‐\ntional information that doesn't fit in the patch name. For example, it might include a\nrationale of WHY the change was necessary.\n\nA technical difference between patch name and patch description, is that matching with\nthe flag `-p` is only done on patch names.\n\nFinally, the `--logfile` option allows you to supply a file that already contains the\npatch name and description. This is useful if a previous record failed and left a\n`darcs/patchdescription.txt` file.\n\nEach patch is attributed to its author, usually by email address (for example, `Fred\nBloggs `). Darcs looks in several places for this author string: the\n`--author` option, the files `darcs/prefs/author` (in the repository) and `~/.darcs/au‐\nthor` (in your home directory), and the environment variables `$DARCSEMAIL` and\n`$EMAIL`. If none of those exist, Darcs will prompt you for an author string and write\nit to `~/.darcs/author`. Note that if you have more than one email address, you can put\nthem all in `~/.darcs/author`, one author per line. Darcs will still prompt you for an\nauthor, but it allows you to select from the list, or to type in an alternative.\n\nIf you want to manually define any explicit dependencies for your patch, you can use the\n`--ask-deps` flag. Some dependencies may be automatically inferred from the patch's con‐\ntent and cannot be removed. A patch with specific dependencies can be empty.\n\nThe patch date is generated automatically. It can only be spoofed by using the `--pipe`\noption.\n\nIf you run record with the `--pipe` option, you will be prompted for the patch date, au‐\nthor, and the long comment. The long comment will extend until the end of file or stdin\nis reached. This interface is intended for scripting darcs, in particular for writing\nrepository conversion scripts. The prompts are intended mostly as a useful guide (since\nscripts won't need them), to help you understand the input format. Here's an example of\nwhat the `--pipe` prompts look like:\n\nWhat is the date? Mon Nov 15 13:38:01 EST 2004\nWho is the author? David Roundy\nWhat is the log? One or more comment lines\n\nIf a test command has been defined with `darcs setpref`, attempting to record a patch\nwill cause the test command to be run in a clean copy of the working tree (that is, in‐\ncluding only recorded changes). If the test fails, you will be offered to abort the\nrecord operation.\n\nThe `--set-scripts-executable` option causes scripts to be made executable in the clean\ncopy of the working tree, prior to running the test. See `darcs clone` for an explana‐\ntion of the script heuristic.\n\nIf your test command is tediously slow (e.g. `make all`) and you are recording several\npatches in a row, you may wish to use `--no-test` to skip all but the final test.\n\nTo see some context (unchanged lines) around each change, use the `--unified` option.\n\ndarcs clone []\nClone creates a copy of a repository. The optional second argument specifies a destina‐\ntion directory for the new copy; if omitted, it is inferred from the source location.\n\nBy default Darcs will copy every patch from the original repository. If you expect the\noriginal repository to remain accessible, you can use `--lazy` to avoid copying patches\nuntil they are needed ('copy on demand'). This is particularly useful when copying a re‐\nmote repository with a long history that you don't care about.\n\nWhen cloning locally, Darcs automatically uses hard linking where possible. As well as\nsaving time and space, this enables to move or delete the original repository without af‐\nfecting the copy. Hard linking requires that the copy be on the same filesystem as the\noriginal repository, and that the filesystem support hard linking. This includes NTFS,\nHFS+ and all general-purpose Unix filesystems (such as ext, UFS and ZFS). FAT does not\nsupport hard links.\n\nWhen cloning from a remote location, Darcs will look for and attempt to use packs created\nby `darcs optimize http` in the remote repository. Packs are single big files that can\nbe downloaded faster than many little files.\n\nDarcs clone will not copy unrecorded changes to the source repository's working tree.\n\nYou can copy a repository to a ssh url, in which case the new repository will always be\ncomplete.\n\nIt is often desirable to make a copy of a repository that excludes some patches. For ex‐\nample, if releases are tagged then `darcs clone --tag .` would make a copy of the reposi‐\ntory as at the latest release.\n\nAn untagged repository state can still be identified unambiguously by a context file, as\ngenerated by `darcs log --context`. Given the name of such a file, the `--context` op‐\ntion will create a repository that includes only the patches from that context. When a\nuser reports a bug in an unreleased version of your project, the recommended way to find\nout exactly what version they were running is to have them include a context file in the\nbug report.\n\nYou can also make a copy of an untagged state using the `--to-patch` or `--to-match` op‐\ntions, which exclude patches *after* the first matching patch. Because these options\ntreat the set of patches as an ordered sequence, you may get different results after re‐\nordering with `darcs optimize reorder`.\n\nThe `--set-scripts-executable` option causes scripts to be made executable in the working\ntree. A script is any file that starts with a shebang (\"#!\").\n\ndarcs pull [repository]...\nPull is used to bring patches made in another repository into the current repository\n(that is, either the one in the current directory, or the one specified with the `--re‐\npodir` option). Pull accepts arguments, which are URLs from which to pull, and when\ncalled without an argument, pull will use the repository specified at `darcs/prefs/de‐\nfaultrepo`.\n\nThe default (`--union`) behavior is to pull any patches that are in any of the specified\nrepositories. If you specify the `--intersection` flag, darcs will only pull those\npatches which are present in all source repositories. If you specify the `--complement`\nflag, darcs will only pull elements in the first repository that do not exist in any of\nthe remaining repositories.\n\nIf `--reorder` is supplied, the set of patches that exist only in the current repository\nis brought at the top of the current history. This will work even if there are no new\npatches to pull.\n\nSee `darcs help apply` for detailed description of many options.\n\ndarcs push [repository]\nPush is the opposite of pull. Push allows you to copy patches from the current reposi‐\ntory into another repository.\n\nIf you give the `--apply-as` flag, darcs will use `sudo` to apply the patches as a dif‐\nferent user. This can be useful if you want to set up a system where several users can\nmodify the same repository, but you don't want to allow them full write access. This\nisn't secure against skilled malicious attackers, but at least can protect your reposi‐\ntory from clumsy, inept or lazy users.\n\n`darcs push` will compress the patch data before sending it to a remote location via ssh.\nThis works as long as the remote darcs is not older than version 2.5. If you get errors\nthat indicate a corrupt patch bundle, you should try again with the `--no-compress` op‐\ntion.\n\n#### Preparing patches before recording:\n\ndarcs move ... \nDarcs cannot reliably distinguish between a file being deleted and a new one added, and a\nfile being moved. Therefore Darcs always assumes the former, and provides the `darcs mv`\ncommand to let Darcs know when you want the latter. This command will also move the file\nin the working tree (unlike `darcs remove`), unless it has already been moved.\n\nDarcs will not rename a file if another file in the same folder has the same name, except\nfor case. The `--case-ok` option overrides this behaviour. Windows and OS X usually use\nfilesystems that do not allow files a folder to have the same name except for case (for\nexample, `ReadMe` and `README`). If `--case-ok` is used, the repository might be unus‐\nable on those systems!\n\ndarcs remove ...\nThe `darcs remove` command exists primarily for symmetry with `darcs add`, as the normal\nway to remove a file from version control is simply to delete it from the working tree.\nThis command is only useful in the unusual case where one wants to record a removal patch\nWITHOUT deleting the copy in the working tree (which can be re-added).\n\nNote that applying a removal patch to a repository (e.g. by pulling the patch) will AL‐\nWAYS affect the working tree of that repository.\n\ndarcs replace ...\nIn addition to line-based patches, Darcs supports a limited form of lexical substitution.\nFiles are treated as sequences of words, and each occurrence of the old word is replaced\nby the new word. This is intended to provide a clean way to rename a function or vari‐\nable. Such renamings typically affect lines all through the source code, so a tradi‐\ntional line-based patch would be very likely to conflict with other branches, requiring\nmanual merging.\n\nFiles are tokenized according to one simple rule: words are strings of valid token char‐\nacters, and everything between them (punctuation and whitespace) is discarded. By de‐\nfault, valid token characters are letters, numbers and the underscore (i.e.\n`[A-Za-z0-9]`). However if the old and/or new token contains either a hyphen or period,\nBOTH hyphen and period are treated as valid (i.e. `[A-Za-z0-9.-]`).\n\nThe set of valid characters can be customized using the `--token-chars` option. The ar‐\ngument must be surrounded by square brackets. If a hyphen occurs between two characters\nin the set, it is treated as a set range. For example, in most locales `[A-Z]` denotes\nall uppercase letters. If the first character is a caret, valid tokens are taken to be\nthe complement of the remaining characters. For example, `[^:\\n]` could be used to match\nfields in the passwd(5), where records and fields are separated by newlines and colons\nrespectively.\n\nIf you choose to use `--token-chars`, you are STRONGLY encouraged to do so consistently.\nThe consequences of using multiple replace patches with different `--token-chars` argu‐\nments on the same file are not well tested nor well understood.\n\nBy default Darcs will refuse to perform a replacement if the new token is already in use,\nbecause the replacements would be not be distinguishable from the existing tokens. This\nbehaviour can be overridden by supplying the `--force` option, but an attempt to `darcs\nrollback` the resulting patch will affect these existing tokens.\n\nLimitations:\n\nThe tokenizer treats files as byte strings, so it is not possible for `--token-chars` to\ninclude multi-byte characters, such as the non-ASCII parts of UTF-8. Similarly, trying\nto replace a \"high-bit\" character from a unibyte encoding will also result in replacement\nof the same byte in files with different encodings. For example, an acute a from ISO\n8859-1 will also match an alpha from ISO 8859-7.\n\nDue to limitations in the patch file format, `--token-chars` arguments cannot contain\nliteral whitespace. For example, `[^ \\n\\t]` cannot be used to declare all characters ex‐\ncept the space, tab and newline as valid within a word, because it contains a literal\nspace.\n\nUnlike POSIX regex(7) bracket expressions, character classes (such as `[[:alnum:]]`) are\nNOT supported by `--token-chars`, and will be silently treated as a simple set of charac‐\nters.\n\n#### Querying the repository:\n\ndarcs log [file|directory]...\nThe `darcs log` command lists patches of the current repository or, with `--repo`, a re‐\nmote repository. Without options or arguments, ALL patches will be listed.\n\nWhen given files or directories paths as arguments, only patches which affect those paths\nare listed. This includes patches that happened to files before they were moved or re‐\nnamed.\n\nWhen given `--from-tag` or `--from-patch`, only patches since that tag or patch are\nlisted. Similarly, the `--to-tag` and `--to-patch` options restrict the list to older\npatches.\n\nThe `--last` and `--max-count` options both limit the number of patches listed. The for‐\nmer applies BEFORE other filters, whereas the latter applies AFTER other filters. For\nexample `darcs log foo.c --max-count 3` will print the last three patches that affect\nfoo.c, whereas `darcs log --last 3 foo.c` will, of the last three patches, print only\nthose that affect foo.c.\n\nFour output formats exist. The default is `--human-readable`. The slightly different\n`--machine-readable` format enables to see patch dependencies in non-interactive mode.\nYou can also select `--context`, which is an internal format that can be re-read by Darcs\n(e.g. `darcs clone --context`).\n\nFinally, there is `--xml-output`, which emits valid XML... unless a the patch metadata\n(author, name or description) contains a non-ASCII character and was recorded in a\nnon-UTF8 locale.\n\ndarcs annotate [file|directory]\nWhen `darcs annotate` is called on a file, it will find the patch that last modified each\nline in that file. This also works on directories.\n\nThe `--machine-readable` option can be used to generate output for machine postprocess‐\ning.\n\ndarcs diff [file|directory]...\nThe `darcs diff` command compares two versions of the working tree of the current reposi‐\ntory. Without options, the pristine (recorded) and unrecorded working trees are com‐\npared. This is lower-level than the `darcs whatsnew` command, since it outputs a\nline-by-line diff, and it is also slower. As with `darcs whatsnew`, if you specify files\nor directories, changes to other files are not listed. The command always uses an exter‐\nnal diff utility.\n\nWith the `--patch` option, the comparison will be made between working trees with and\nwithout that patch. Patches *after* the selected patch are not present in either of the\ncompared working trees. The `--from-patch` and `--to-patch` options allow the set of\npatches in the `old' and `new' working trees to be specified separately.\n\nThe associated tag and match options are also understood, e.g. `darcs diff --from-tag 1.0\n--to-tag 1.1`. All these options assume an ordering of the patch set, so results may be\naffected by operations such as `darcs optimize reorder`.\n\ndiff(1) is called with the arguments `-rN`. The `--unified` option causes `-u` to be\npassed to diff(1). An additional argument can be passed using `--diff-opts`, such as\n`--diff-opts=-ud` or `--diff-opts=-wU9`.\n\nThe `--diff-command` option can be used to specify an alternative utility. Arguments may\nbe included, separated by whitespace. The value is not interpreted by a shell, so shell\nconstructs cannot be used. The arguments %1 and %2 MUST be included, these are substi‐\ntuted for the two working trees being compared. For instance:\n\ndarcs diff -p . --diff-command \"meld %1 %2\"\n\nIf this option is used, `--diff-opts` is ignored.\n\ndarcs show contents [file]...\nShow contents can be used to display an earlier version of some file(s). If you give\nshow contents no version arguments, it displays the recorded version of the file(s).\n\n#### darcs show dependencies\n\nThe `darcs show dependencies` command is used to create a graph of the dependencies be‐\ntween patches of the repository (by default up to last tag).\n\nThe resulting graph is described in Dot Language, a general example of use could be:\n\ndarcs show dependencies | dot -Tpdf -o FILE.pdf\n\ndarcs show files [file|directory]...\nThe `darcs show files` command lists those files and directories in the working tree that\nare under version control. This command is primarily for scripting purposes; end users\nwill probably want `darcs whatsnew --summary`.\n\nA file is \"pending\" if it has been added but not recorded. By default, pending files\n(and directories) are listed; the `--no-pending` option prevents this.\n\nBy default `darcs show files` lists both files and directories, but the `--no-files` and\n`--no-directories` flags modify this behaviour.\n\nBy default entries are one-per-line (i.e. newline separated). This can cause problems if\nthe files themselves contain newlines or other control characters. To get around this,\nthe `--null` option uses the null character instead. The script interpreting output from\nthis command needs to understand this idiom; `xargs -0` is such a command.\n\nFor example, to list version-controlled files by size:\n\ndarcs show files -0 | xargs -0 ls -ldS\n\n#### darcs show index\n\nThe `darcs show index` command lists all version-controlled files and directories along\nwith their hashes as stored in `darcs/index`. For files, the fields correspond to file\nsize, sha256 of the current file content and the filename.\n\n#### darcs show pristine\n\nThe `darcs show pristine` command lists all version-controlled files and directories\nalong with the hashes of their pristine copies. For files, the fields correspond to file\nsize, sha256 of the pristine file content and the filename.\n\n#### darcs show repo\n\nThe `darcs show repo` command displays statistics about the current repository, allowing\nthird-party scripts to access this information without inspecting `darcs` directly (and\nwithout breaking when the `darcs` format changes).\n\nThe 'Weak Hash' identifies the set of patches of a repository independently of ordering.\nIt can be used to easily compare two repositories of a same project. It is not crypto‐\ngraphically secure.\n\nBy default, output includes statistics that require walking through the patches recorded\nin the repository, namely the 'Weak Hash' and the count of patches. If this data isn't\nneeded, use `--no-enum-patches` to accelerate this command from O(n) to O(1).\n\nBy default, output is in a human-readable format. The `--xml-output` option can be used\nto generate output for machine postprocessing.\n\n#### darcs show authors\n\nThe `darcs show authors` command lists the authors of the current repository, sorted by\nthe number of patches contributed. With the `--verbose` option, this command simply\nlists the author of each patch (without aggregation or sorting).\n\nAn author's name or email address may change over time. To tell Darcs when multiple au‐\nthor strings refer to the same individual, create an `.authorspellings` file in the root\nof the working tree. Each line in this file begins with an author's canonical name and\naddress, and may be followed by a comma separated list of extended regular expressions.\nBlank lines and lines beginning with two hyphens are ignored. The format of `.author‐\nspelling` can be described by this pattern:\n\nname
[, regexp ]*\n\nThere are some pitfalls concerning special characters: Whitespaces are stripped, if you\nneed space in regexp use [ ]. Because comma serves as a separator you have to escape it\nif you want it in regexp. Note that `.authorspelling` use extended regular expressions so\n+, ? and so on are metacharacters and you need to escape them to be interpreted liter‐\nally.\n\nAny patch with an author string that matches the canonical address or any of the associ‐\nated regexps is considered to be the work of that author. All matching is case-insensi‐\ntive and partial (it can match a substring). Use ^,$ to match the whole string in regexps\n\nCurrently this canonicalization step is done only in `darcs show authors`. Other com‐\nmands, such as `darcs log` use author strings verbatim.\n\nAn example `.authorspelling` file is:\n\n-- This is a comment.\nFred Nurk \nJohn Snagge , John, snagge@, js@(si|mit).edu\nChuck Jones\\, Jr. , cj\\+user@example.com\n\n#### darcs show tags\n\nThe tags command writes a list of all tags in the repository to standard output.\n\nTab characters (ASCII character 9) in tag names are changed to spaces for better interop‐\nerability with shell tools. A warning is printed if this happens.\n\n#### darcs show patch-index\n\nWhen given the `--verbose` flag, the command dumps the complete content of the patch in‐\ndex and checks its integrity.\ndarcs test [[initialization] command]\nRun test on the current recorded state of the repository. Given no arguments, it uses\nthe default repository test (see `darcs setpref`). Given one argument, it treats it as a\ntest command. Given two arguments, the first is an initialization command and the second\nis the test (meaning the exit code of the first command is not taken into account to de‐\ntermine success of the test). If given the `--linear` or `--bisect` flags, it tries to\nfind the most recent version in the repository which passes a test.\n\n`--linear` does linear search starting from head, and moving away from head. This strat‐\negy is best when the test runs very quickly or the patch you're seeking is near the head.\n\n`--bisect` does binary search. This strategy is best when the test runs very slowly or\nthe patch you're seeking is likely to be in the repository's distant past.\n\n`--backoff` starts searching from head, skipping further and further into the past until\nthe test succeeds. It then does a binary search on a subset of those skipped patches.\nThis strategy works well unless the patch you're seeking is in the repository's distant\npast.\n\nUnder the assumption that failure is monotonous, `--linear` and `--bisect` produce the\nsame result. (Monotonous means that when moving away from head, the test result changes\nonly once from \"fail\" to \"ok\".) If failure is not monotonous, any one of the patches\nthat break the test is found at random.\n\n#### Undoing and correcting:\n\ndarcs revert [file|directory]...\nThe `darcs revert` command discards unrecorded changes the working tree. As with `darcs\nrecord`, you will be asked which hunks (changes) to revert. The `--all` switch can be\nused to avoid such prompting. If files or directories are specified, other parts of the\nworking tree are not reverted.\n\nIn you accidentally reverted something you wanted to keep (for example, typing `darcs rev\n-a` instead of `darcs rec -a`), you can immediately run `darcs unrevert` to restore it.\nThis is only guaranteed to work if the repository has not changed since `darcs revert`\nran.\n\n#### darcs unrevert\n\nUnrevert is a rescue command in case you accidentally reverted something you wanted to\nkeep (for example, typing `darcs rev -a` instead of `darcs rec -a`).\n\nThis command may fail if the repository has changed since the revert took place. Darcs\nwill ask for confirmation before executing an interactive command that will DEFINITELY\nprevent unreversion.\n\ndarcs amend [file|directory]...\nAmend updates a \"draft\" patch with additions or improvements, resulting in a single \"fin‐\nished\" patch.\n\nBy default `amend` proposes you to record additional changes. If instead you want to re‐\nmove changes, use the flag `--unrecord`.\n\nWhen recording a draft patch, it is a good idea to start the name with `DRAFT:`. When\ndone, remove it with `darcs amend --edit-long-comment`. Alternatively, to change the\npatch name without starting an editor, use the `--name`/`-m` flag:\n\ndarcs amend --match 'name \"DRAFT: foo\"' --name 'foo2'\n\nLike `darcs record`, if you call amend with files as arguments, you will only be asked\nabout changes to those files. So to amend a patch to foo.c with improvements in bar.c,\nyou would run:\n\ndarcs amend --match 'touch foo.c' bar.c\n\nIt is usually a bad idea to amend another developer's patch. To make amend only ask\nabout your own patches by default, you can add something like `amend match David Roundy`\nto `~/.darcs/defaults`, where `David Roundy` is your name.\n\ndarcs rebase pull [repository]...\nCopy and apply patches from another repository, suspending any local patches that con‐\nflict.\ndarcs rebase apply \nApply a patch bundle, suspending any local patches that conflict.\n\n#### darcs rebase suspend\n\nSelect patches to move into a suspended state at the end of the repo.\n\n#### darcs rebase unsuspend\n\nSelected patches to restore from a suspended state to the end of the repo.\n\n#### darcs rebase obliterate\n\nObliterate a patch that is currently suspended.\n\n#### darcs rebase log\n\nList the currently suspended changes.\n\ndarcs rollback [file|directory]...\nRollback is used to undo the effects of some changes from patches in the repository. The\nselected changes are undone in your working tree, but the repository is left unchanged.\nFirst you are offered a choice of which patches to undo, then which changes within the\npatches to undo.\n\nBefore doing `rollback`, you may want to temporarily undo the changes of your working\ntree (if there are) and save them for later use. To do so, you can run `revert`, then\nrun `rollback`, record a patch, and run `unrevert` to restore the saved changes into your\nworking tree.\n\n#### darcs unrecord\n\nUnrecord does the opposite of record: it deletes patches from the repository, without\nchanging the working tree. Deleting patches from the repository makes active changes\nagain which you may record or revert later. Beware that you should not use this command\nif there is a possibility that another user may have already pulled the patch.\n\n#### darcs obliterate\n\nObliterate completely removes recorded patches from your local repository. The changes\nwill be undone in your working tree and the patches will not be shown in your changes\nlist anymore. Beware that you can lose precious code by obliterating!\n\nOne way to save obliterated patches is to use the -O flag. A patch bundle will be created\nlocally, that you will be able to apply later to your repository with `darcs apply`.\n\n#### Direct modification of the repository:\n\ndarcs tag [tagname]\nThe `darcs tag` command names the current repository state, so that it can easily be re‐\nferred to later. Every *important* state should be tagged; in particular it is good\npractice to tag each stable release with a number or codename. Advice on release number‐\ning can be found at .\n\nTo reproduce the state of a repository `R` as at tag `t`, use the command `darcs clone\n--tag t R`. The command `darcs show tags` lists all tags in the current repository.\n\nTagging also provides significant performance benefits: when Darcs reaches a shared tag\nthat depends on all antecedent patches, it can simply stop processing.\n\nLike normal patches, a tag has a name, an author, a timestamp and an optional long de‐\nscription, but it does not change the working tree. A tag can have any name, but it is\ngenerally best to pick a naming scheme and stick to it.\n\nBy default a tag names the entire repository state at the time the tag is created. If the\n--ask-deps option is used, the patches to include as part of the tag can be explicitly\nselected.\n\nThe `darcs tag` command accepts the `--pipe` option, which behaves as described in `darcs\nrecord`.\n\ndarcs setpref \nWhen working on project with multiple repositories and contributors, it is sometimes de‐\nsirable for a preference to be set consistently project-wide. This is achieved by treat‐\ning a preference set with `darcs setpref` as an unrecorded change, which can then be\nrecorded and then treated like any other patch.\n\nValid preferences are:\n\n* test -- a shell command that runs regression tests * predist -- a shell command to run\nbefore `darcs dist' * boringfile -- the path to a version-controlled boring file * bina‐\nriesfile -- the path to a version-controlled binaries file\n\nFor example, a project using GNU autotools, with a `make test` target to perform regres‐\nsion tests, might enable Darcs' integrated regression testing with the following command:\n\ndarcs setpref test 'autoconf && ./configure && make && make test'\n\nNote that merging is not currently implemented for preferences: if two patches attempt to\nset the same preference, the last patch applied to the repository will always take prece‐\ndence. This is considered a low-priority bug, because preferences are seldom set.\n\n#### Exchanging patches by e-mail:\n\ndarcs send [repository]\nSend is used to prepare a bundle of patches that can be applied to a target repository.\nSend accepts the URL of the repository as an argument. When called without an argument,\nsend will use the most recent repository that was either pushed to, pulled from or sent\nto. By default, the patch bundle is saved to a file, although you may directly send it\nby mail.\n\nThe `--output`, `--output-auto-name`, and `--to` flags determine what darcs does with the\npatch bundle after creating it. If you provide an `--output` argument, the patch bundle\nis saved to that file. If you specify `--output-auto-name`, the patch bundle is saved to\na file with an automatically generated name. If you give one or more `--to` arguments,\nthe bundle of patches is sent to those locations. The locations may either be email ad‐\ndresses or urls that the patch should be submitted to via HTTP.\n\nIf you provide the `--mail` flag, darcs will look at the contents of the\n`darcs/prefs/email` file in the target repository (if it exists), and send the patch by\nemail to that address. In this case, you may use the `--cc` option to specify additional\nrecipients without overriding the default repository email address.\n\nIf `darcs/prefs/post` exists in the target repository, darcs will upload to the URL con‐\ntained in that file, which may either be a `mailto:` URL, or an `http://` URL. In the\nlatter case, the patch is posted to that URL.\n\nIf there is no email address associated with the repository, darcs will prompt you for an\nemail address.\n\nUse the `--subject` flag to set the subject of the e-mail to be sent. If you don't pro‐\nvide a subject on the command line, darcs will make one up based on names of the patches\nin the patch bundle.\n\nUse the `--in-reply-to` flag to set the In-Reply-To and References headers of the e-mail\nto be sent. By default no additional headers are included so e-mail will not be treated\nas reply by mail readers.\n\nIf you want to include a description or explanation along with the bundle of patches, you\nneed to specify the `--edit-description` flag, which will cause darcs to open up an edi‐\ntor with which you can compose a message to go along with your patches.\n\nIf you want to use a command different from the default one for sending email, you need\nto specify a command line with the `--sendmail-command` option. The command line can con‐\ntain some format specifiers which are replaced by the actual values. Accepted format\nspecifiers are `%s` for subject, `%t` for to, `%c` for cc, `%b` for the body of the mail,\n`%f` for from, `%a` for the patch bundle and the same specifiers in uppercase for the\nURL-encoded values. Additionally you can add `%<` to the end of the command line if the\ncommand expects the complete email message on standard input. E.g. the command lines for\nevolution and msmtp look like this:\n\nevolution \"mailto:%T?subject=%S&attach=%A&cc=%C&body=%B\"\nmsmtp -t %<\n\nDo not confuse the `--author` options with the return address that `darcs send` will set\nfor your patch bundle.\n\nFor example, if you have two email addresses A and B:\n\n* If you use `--author A` but your machine is configured to send mail from\naddress B by default, then the return address on your message will be B. * If you use\n`--from A` and your mail client supports setting the\nFrom: address arbitrarily (some non-Unix-like mail clients, especially,\nmay not support this), then the return address will be A; if it does\nnot support this, then the return address will be B. * If you supply neither `--from`\nnor `--author` then the return\naddress will be B.\n\nIn addition, unless you specify the sendmail command with `--sendmail-command`, darcs\nsends email using the default email command on your computer. This default command is de‐\ntermined by the `configure` script. Thus, on some non-Unix-like OSes, `--from` is likely\nto not work at all.\n\ndarcs apply \nThe `darcs apply` command takes a patch bundle and attempts to insert it into the current\nrepository. In addition to invoking it directly on bundles created by `darcs send`, it\nis used internally by `darcs push` on the remote end of an SSH connection.\n\nIf no file is supplied, the bundle is read from standard input.\n\nIf given an email instead of a patch bundle, Darcs will look for the bundle as a MIME at‐\ntachment to that email. Currently this will fail if the MIME boundary is rewritten, such\nas in Courier and Mail.app.\n\nIf the `--reply noreply@example.net` option is used, and the bundle is attached to an\nemail, Darcs will send a report (indicating success or failure) to the sender of the bun‐\ndle (the `To` field). The argument to noreply is the address the report will appear to\noriginate FROM.\n\nThe `--cc` option will cause the report to be CC'd to another address, for example `--cc\nreports@lists.example.net,admin@lists.example.net`. Using `--cc` without `--reply` is\nundefined.\n\nIf you want to use a command different from the default one for sending mail, you need to\nspecify a command line with the `--sendmail-command` option. The command line can con‐\ntain the format specifier `%t` for to and you can add `%<` to the end of the command line\nif the command expects the complete mail on standard input. For example, the command line\nfor msmtp looks like this:\n\nmsmtp -t %<\n\nIf gpg(1) is installed, you can use `--verify pubring.gpg` to reject bundles that aren't\nsigned by a key in `pubring.gpg`.\n\nIf `--test` is supplied and a test is defined (see `darcs setpref`), the bundle will be\nrejected if the test fails after applying it. In that case, the rejection email from\n`--reply` will include the test output.\n\nA patch bundle may introduce unresolved conflicts with existing patches or with the work‐\ning tree. By default, Darcs will add conflict markers (see `darcs mark-conflicts`).\n\nThe `--external-merge` option lets you resolve these conflicts using an external merge\ntool. In the option, `%a` is replaced with the common ancestor (merge base), `%1` with\nthe first version, `%2` with the second version, and `%o` with the path where your re‐\nsolved content should go. For example, to use the xxdiff visual merge tool you'd spec‐\nify: `--external-merge='xxdiff -m -O -M %o %1 %a %2'`\n\nThe `--allow-conflicts` option will skip conflict marking; this is useful when you want\nto treat a repository as just a bunch of patches, such as using `darcs pull --union` to\ndownload of your co-workers patches before going offline.\n\nThis can mess up unrecorded changes in the working tree, forcing you to resolve the con‐\nflict immediately. To simply reject bundles that introduce unresolved conflicts, using\nthe `--dont-allow-conflicts` option. Making this the default in push-based workflows is\nstrongly recommended.\n\nUnlike most Darcs commands, `darcs apply` defaults to `--all`. Use the `--interactive`\noption to pick which patches to apply from a bundle.\n\n#### Other commands:\n\n#### darcs optimize clean\n\nThis command deletes obsolete files within the repository.\n\n#### darcs optimize http\n\nUsing this option creates 'repository packs' that could dramatically speed up performance\nwhen a user does a `darcs clone` of the repository over HTTP. To make use of packs, the\nclients must have a darcs of at least version 2.10.\n\n#### darcs optimize reorder\n\nThis command moves recent patches (those not included in the latest tag) to the \"front\",\nreducing the amount that a typical remote command needs to download. It should also re‐\nduce the CPU time needed for some operations.\n\n#### darcs optimize enable-patch-index\n\nBuild the patch index, an internal data structure that accelerates commands that need to\nknow what patches touch a given file. Such as annotate and log.\n\n#### darcs optimize disable-patch-index\n\nDelete and stop maintaining the patch index from the repository.\n\n#### darcs optimize compress\n\nBy default patches are compressed with zlib (RFC 1951) to reduce storage (and download)\nsize. In exceptional circumstances, it may be preferable to avoid compression. In this\ncase the `--dont-compress` option can be used (e.g. with `darcs record`) to avoid com‐\npression.\n\nThe `darcs optimize uncompress` and `darcs optimize compress` commands can be used to en‐\nsure existing patches in the current repository are respectively uncompressed or com‐\npressed.\n\n#### darcs optimize uncompress\n\nBy default patches are compressed with zlib (RFC 1951) to reduce storage (and download)\nsize. In exceptional circumstances, it may be preferable to avoid compression. In this\ncase the `--dont-compress` option can be used (e.g. with `darcs record`) to avoid com‐\npression.\n\nThe `darcs optimize uncompress` and `darcs optimize compress` commands can be used to en‐\nsure existing patches in the current repository are respectively uncompressed or com‐\npressed.\n\n#### darcs optimize relink\n\nThe `darcs optimize relink` command hard-links patches that the current repository has in\ncommon with its peers. Peers are those repositories listed in `darcs/prefs/sources`, or\ndefined with the `--sibling` option (which can be used multiple times).\n\nDarcs uses hard-links automatically, so this command is rarely needed. It is most useful\nif you used `cp -r` instead of `darcs clone` to copy a repository, or if you pulled the\nsame patch from a remote repository into multiple local repositories.\n\n#### darcs optimize pristine\n\nThis command updates the format of `darcs/pristine.hashed/`, which was different before\ndarcs 2.3.1.\n\n#### darcs optimize upgrade\n\nConvert old-fashioned repositories to the current default hashed format.\ndarcs optimize cache ...\nThis command deletes obsolete files within the global cache. It takes one or more direc‐\ntories as arguments, and recursively searches all repositories within these directories.\nThen it deletes all files in the global cache not belonging to these repositories. When\nno directory is given, it searches repositories in the user's home directory.\n\nIt also automatically migrates the global cache to the (default) bucketed format.\n\n#### darcs dist\n\n`darcs dist` creates a compressed archive in the repository's root directory, containing\nthe recorded state of the working tree (unrecorded changes and the `darcs` directory are\nexcluded). The command accepts matchers to create an archive of some past repository\nstate, for instance `--tag`.\n\nBy default, the archive (and the top-level directory within the archive) has the same\nname as the repository, but this can be overridden with the `--dist-name` option.\n\nIf a predist command is set (see `darcs setpref`), that command will be run on the\nrecorded state prior to archiving. For example, autotools projects would set it to `au‐\ntoconf && automake`.\n\nIf `--zip` is used, matchers and the predist command are ignored.\n\ndarcs mark-conflicts [file|directory]...\nDarcs requires human guidance to unify changes to the same part of a source file. When a\nconflict first occurs, darcs will add the initial state and both choices to the working\ntree, delimited by the markers `v v v`, `=====`, `* * *` and `^ ^ ^`, as follows:\n\nv v v v v v v\nInitial state.\n=============\nFirst choice.\n*\nSecond choice.\n^ ^ ^ ^ ^ ^ ^\n\nHowever, you might revert or manually delete these markers without actually resolving the\nconflict. In this case, `darcs mark-conflicts` is useful to show where are the unre‐\nsolved conflicts. It is also useful if `darcs apply` or `darcs pull` is called with\n`--allow-conflicts`, where conflicts aren't marked initially.\n\nUnless you use the `--dry-run` flag, any unrecorded changes to the affected files WILL be\nlost forever when you run this command! You will be prompted for confirmation before\nthis takes place.\n\n#### darcs repair\n\nThe `darcs repair` command attempts to fix corruption in the current repository. Cur‐\nrently it can only repair damage to the pristine tree, which is where most corruption oc‐\ncurs. This command rebuilds a pristine tree by applying successively the patches in the\nrepository to an empty tree.\n\nThe flag `--dry-run` make this operation read-only, making darcs exit unsuccessfully\n(with a non-zero exit status) if the rebuilt pristine is different from the current pris‐\ntine.\n\ndarcs convert darcs-2 []\nThis command converts a repository that uses the old patch semantics `darcs-1` to a new\nrepository with current `darcs-2` semantics.\n\nWARNING: the repository produced by this command is not understood by Darcs 1.x, and\npatches cannot be exchanged between repositories in darcs-1 and darcs-2 formats.\n\nFurthermore, repositories created by different invocations of this command SHOULD NOT ex‐\nchange patches.\n\n#### darcs convert export\n\nThis command enables you to export darcs repositories into git.\n\nFor a one-time export you can use the recipe:\n\n$ cd repo\n$ git init ../mirror\n$ darcs convert export | (cd ../mirror && git fast-import)\n\nFor incremental export using marksfiles:\n\n$ cd repo\n$ git init ../mirror\n$ touch ../mirror/git.marks\n$ darcs convert export --read-marks darcs.marks --write-marks darcs.marks\n| (cd ../mirror && git fast-import --import-marks=git.marks --ex‐\nport-marks=git.marks)\n\nIn the case of incremental export, be careful to never amend, delete or reorder patches\nin the source darcs repository.\n\nAlso, be aware that exporting a darcs repo to git will not be exactly faithful in terms\nof history if the darcs repository contains conflicts.\n\nLimitations:\n\n* Empty directories are not supported by the fast-export protocol. * Unicode filenames\nare currently not correctly handled.\nSee http://bugs.darcs.net/issue2359 .\n\ndarcs convert import []\nThis command imports git repositories into new darcs repositories. Further options are\naccepted (see `darcs help init`).\n\nTo convert a git repo to a new darcs one you may run:\n$ (cd gitrepo && git fast-export --all -M) | darcs convert import darcsmirror\n\nWARNING: git repositories with branches will produce weird results,\nuse at your own risks.\n\nIncremental import with marksfiles is currently not supported.\n\ndarcs fetch [repository]...\nFetch is similar to `pull` except that it does not apply any patches to the current\nrepository. Instead, it generates a patch bundle that you can apply later with `apply`.\n\nFetch's behaviour is essentially similar to pull's, so please consult the help of `pull`\nto know more.\n\n### ENVIRONMENT\n\n#### HOME and APPDATA\n\nPer-user preferences are set in $HOME/.darcs (on Unix) or %APPDATA%/darcs (on Windows). This\nis also the default location of the cache.\n\nDARCSEDITOR, VISUAL, and EDITOR\nTo edit a patch description of email comment, Darcs will invoke an external editor. Your\npreferred editor can be set as any of the environment variables $DARCSEDITOR, $VISUAL or\n$EDITOR. If none of these are set, nano is used. If nano crashes or is not found in your\nPATH, vi, emacs, emacs -nw and (on Windows) edit are each tried in turn.\n\nDARCSPAGER and PAGER\nDarcs will invoke a pager if the output of some command is longer than 20 lines. Darcs will\nuse the pager specified by $DARCSPAGER or $PAGER. If neither are set, `less` will be used.\n\nDARCSDONTCOLOR, DARCSALWAYSCOLOR, DARCSALTERNATIVECOLOR, and DARCSDOCOLORLINES\nIf the terminal understands ANSI color escape sequences, darcs will highlight certain key‐\nwords and delimiters when printing patches. This can be turned off by setting the environment\nvariable DARCSDONTCOLOR to 1. If you use a pager that happens to understand ANSI colors,\nlike `less -R`, darcs can be forced always to highlight the output by setting DARCSAL‐\nWAYSCOLOR to 1. If you can't see colors you can set DARCSALTERNATIVECOLOR to 1, and darcs\nwill use ANSI codes for bold and reverse video instead of colors. In addition, there is an\nextra-colorful mode, which is not enabled by default, which can be activated with\nDARCSDOCOLORLINES\n\nDARCSDONTESCAPETRAILINGSPACES and DARCSDONTESCAPETRAILINGCR\nBy default darcs will escape (by highlighting if possible) any kind of spaces at the end of\nlines when showing patch contents. If you don't want this you can turn it off by setting\nDARCSDONTESCAPETRAILINGSPACES to 1. A special case exists for only carriage returns:\nDARCSDONTESCAPETRAILINGCR\n\nDARCSDONTESCAPEANYTHING, DARCSDONTESCAPEEXTRA, DARCSESCAPEEXTRA, DARCSDONTESCAPEIS‐‐\nPRINT, and DARCSESCAPE8BIT\nDarcs needs to escape certain characters when printing patch contents to a terminal, depend‐\ning on the encoding specified in your locale setting.\n\nBy default, darcs assumes that your locale encoding is ASCII compatible. This includes UTF-8\nand some 8-bit encodings like ISO/IEC-8859 (including its variants). Since ASCII contains\ncontrol characters like backspace (which could hide patch content from the user when printed\nliterally to the terminal), and even ones that may introduce security risks such as redirect‐\ning commands to the shell, darcs needs to escape such characters. They are printed as\n`^` or `\\`. Darcs also uses special markup for line endings that\nare preceeded by white space, since the white space would otherwise not be recognizable.\n\nIf you use an encoding that is not ASCII compatible, things are somewhat less smooth. Such\nencodings include UTF-16 and UTF-32, as well as many of the encodings that became obsolete\nwith unicode. In this case you have two options: you can set DARCSDONTESCAPEANYTHING to 1.\nThen everything that doesn't flip code sets should work, and so will all the bells and whis‐\ntles in your terminal. This environment variable can also be handy if you pipe the output to\na pager or external filter that knows better than darcs how to handle your encoding. Note\nthat all escaping, including the special escaping of any line ending spaces, will be turned\noff by this setting.\n\nAnother possibility is to explicitly tell darcs to not escape or escape certain bytes, using\nDARCSDONTESCAPEEXTRA and DARCSESCAPEEXTRA. Their values should be strings consisting of\nthe verbatim bytes in question. The do-escapes take precedence over the dont-escapes. Space\ncharacters are still escaped at line endings though. The special environment variable\nDARCSDONTESCAPETRAILINGCR turns off escaping of carriage return last on the line (DOS\nstyle).\n\nFor historical reasons, darcs also supports DARCSDONTESCAPEISPRINT and DARCSUSEISPRINT\n(which are synonyms). These make sense only for 8-bit encodings like ISO-8859 and are no\nlonger needed since nowadays darcs does the right thing here by default.\n\nFinally, if you are in a highly security sensitive situation (or just paranoid for other rea‐\nsons), you can set DARCSESCAPE8BIT to 1. This will cause darcs to escape every non-ASCII\nbyte in addition to ASCII control characters.\n\nDARCSTMPDIR and TMPDIR\nDarcs often creates temporary directories. For example, the `darcs diff` command creates two\nfor the working trees to be diffed. By default temporary directories are created in /tmp, or\nif that doesn't exist, in darcs (within the current repo). This can be overridden by speci‐\nfying some other directory in the file darcs/prefs/tmpdir or the environment variable\n$DARCSTMPDIR or $TMPDIR.\n\nDARCSKEEPTMPDIR\nIf the environment variable DARCSKEEPTMPDIR is defined, darcs will not remove the temporary\ndirectories it creates. This is intended primarily for debugging Darcs itself, but it can\nalso be useful, for example, to determine why your test preference (see `darcs setpref`) is\nfailing when you run `darcs record`, but working when run manually.\n\nDARCSEMAIL and EMAIL\nEach patch is attributed to its author, usually by email address (for example, `Fred Bloggs\n`). Darcs looks in several places for this author string: the `--author`\noption, the files `darcs/prefs/author` (in the repository) and `~/.darcs/author` (in your\nhome directory), and the environment variables `$DARCSEMAIL` and `$EMAIL`. If none of those\nexist, Darcs will prompt you for an author string and write it to `~/.darcs/author`. Note\nthat if you have more than one email address, you can put them all in `~/.darcs/author`, one\nauthor per line. Darcs will still prompt you for an author, but it allows you to select from\nthe list, or to type in an alternative.\n\nSENDMAIL\nOn Unix, the `darcs send` command relies on sendmail(8). The `--sendmail-command` or $SEND‐\nMAIL environment variable can be used to provide an explicit path to this program; otherwise\nthe standard locations /usr/sbin/sendmail and /usr/lib/sendmail will be tried.\n\nDARCSSLOPPYLOCKS\nIf on some filesystems you get an error of the kind:\n\ndarcs: takeLock [...]: atomiccreate [...]: unsupported operation\n\nyou may want to try to export DARCSSLOPPYLOCKS=True.\n\nDARCSSSH\nRepositories of the form [user@]host:[dir] are taken to be remote repositories, which Darcs\naccesses with the external program ssh(1).\n\nThe environment variable $DARCSSSH can be used to specify an alternative SSH client. Argu‐\nments may be included, separated by whitespace. The value is not interpreted by a shell, so\nshell constructs cannot be used; in particular, it is not possible for the program name to\ncontain whitespace by using quoting or escaping.\n\nDARCSSCP and DARCSSFTP\nWhen reading from a remote repository, Darcs will attempt to run `darcs transfer-mode` on the\nremote host. This will fail if the remote host only has Darcs 1 installed, doesn't have\nDarcs installed at all, or only allows SFTP.\n\nIf transfer-mode fails, Darcs will fall back on scp(1) and sftp(1). The commands invoked can\nbe customized with the environment variables $DARCSSCP and $DARCSSFTP respectively, which\nbehave like $DARCSSSH. If the remote end allows only sftp, try setting DARCSSCP=sftp.\n\nSSHPORT\nIf this environment variable is set, it will be used as the port number for all SSH calls\nmade by Darcs (when accessing remote repositories over SSH). This is useful if your SSH\nserver does not run on the default port, and your SSH client does not support sshconfig(5).\nOpenSSH users will probably prefer to put something like `Host *.example.net Port 443` into\ntheir ~/.ssh/config file.\n\nHTTPPROXY, HTTPSPROXY, FTPPROXY, ALLPROXY, and NOPROXY\nIf Darcs was built with libcurl, the environment variables HTTPPROXY, HTTPSPROXY and\nFTPPROXY can be set to the URL of a proxy in the form\n\n[protocol://][:port]\n\nIn which case libcurl will use the proxy for the associated protocol (HTTP, HTTPS and FTP).\nThe environment variable ALLPROXY can be used to set a single proxy for all libcurl re‐\nquests.\n\nIf the environment variable NOPROXY is a comma-separated list of host names, access to those\nhosts will bypass proxies defined by the above variables. For example, it is quite common to\navoid proxying requests to machines on the local network with\n\nNOPROXY=localhost,*.localdomain\n\nFor compatibility with lynx et al, lowercase equivalents of these environment variables (e.g.\n$httpproxy) are also understood and are used in preference to the uppercase versions.\n\nIf Darcs was not built with libcurl, all these environment variables are silently ignored,\nand there is no way to use a web proxy.\n\nDARCSPROXYUSERPWD\nIf Darcs was built with libcurl, and you are using a web proxy that requires authentication,\nyou can set the $DARCSPROXYUSERPWD environment variable to the username and password ex‐\npected by the proxy, separated by a colon. This environment variable is silently ignored if\nDarcs was not built with libcurl.\n\nDARCSCONNECTIONTIMEOUT\nSet the maximum time in seconds that darcs allows and connection to take. If the variable is\nnot specified the default are 30 seconds. This option only works with curl.\n\n### FILES\n\ndarcs/prefs/motd\nThe `darcs/prefs/motd` file may contain a 'message of the day' which will be displayed to\nusers who clone or pull from the repository without the `--quiet` option.\n\n\ndarcs/prefs/email\nThe `darcs/prefs/email` file is used to provide the e-mail address for your repository that\nothers will use when they `darcs send` a patch back to you. The contents of the file should\nsimply be an e-mail address.\n\n\ndarcs/prefs/post\nIf `darcs/prefs/post` exists in the target repository, `darcs send ` will upload to the URL\ncontained in that file, which may either be a `mailto:` URL, or an `http://` URL. In the lat‐\nter case, the patch is posted to that URL.\n\n\ndarcs/prefs/author\nThe `darcs/prefs/author` file contains the email address (or name) to be used as the author\nwhen patches are recorded in this repository, e.g. `David Roundy `.\nThis file overrides the contents of the environment variables `$DARCSEMAIL` and `$EMAIL`.\n\n\ndarcs/prefs/defaults\nDefault values for darcs commands. Each line of this file has the following form:\n\nCOMMAND FLAG VALUE\n\nwhere `COMMAND` is either the name of the command to which the default applies, or `ALL` to\nindicate that the default applies to all commands accepting that flag. The `FLAG` term is the\nname of the long argument option without the `--`, i.e. `verbose` rather than `--verbose`.\nFinally, the `VALUE` option can be omitted if the flag does not involve a value. If the value\nhas spaces in it, use single quotes, not double quotes, to surround it. Each line only takes\none flag. To set multiple defaults for the same command (or for `ALL` commands), use multiple\nlines.\n\nNote that the use of `ALL` easily can have unpredicted consequences, especially if commands\nin newer versions of darcs accepts flags that they did not in previous versions. Only use\nsafe flags with `ALL`.\n\nFor example, if your system clock is bizarre, you could instruct darcs to always ignore the\nfile modification times by adding the following line:\n\nALL ignore-times\n\nThere are some options which are meant specifically for use in `darcs/prefs/defaults`. One\nof them is `--disable`. As the name suggests, this option will disable every command that got\nit as argument. So, if you are afraid that you could damage your repositories by inadvertent\nuse of a command like amend, add the following line:\n\namend disable\n\nAlso, a global preferences file can be created with the name `.darcs/defaults` in your home\ndirectory. Options present there will be added to the repository-specific preferences if they\ndo not conflict.\n\n\ndarcs/prefs/sources\nThe `darcs/prefs/sources` file is used to indicate alternative locations from which to down‐\nload patches. This file contains lines such as:\n\ncache:/home/droundy/.cache/darcs\nreadonly:/home/otheruser/.cache/darcs\nrepo:http://darcs.net\n\nThis would indicate that darcs should first look in `/home/droundy/.cache/darcs` for patches\nthat might be missing, and if the patch is not there, it should save a copy there for future\nuse. In that case, darcs will look in `/home/otheruser/.cache/darcs` to see if that user\nmight have downloaded a copy, but will not try to save a copy there, of course. Finally, it\nwill look in `http://darcs.net`. Note that the `sources` file can also exist in `~/.darcs/`.\nAlso note that the sources mentioned in your `sources` file will be tried *before* the repos‐\nitory you are pulling from. This can be useful in avoiding downloading patches multiple times\nwhen you pull from a remote repository to more than one local repository.\n\nA global cache is enabled by default in your home directory. The cache allows darcs to avoid\nre-downloading patches (for example, when doing a second darcs clone of the same repository),\nand also allows darcs to use hard links to reduce disk usage.\n\nNote that the cache directory should reside on the same filesystem as your repositories, so\nyou may need to vary this. You can also use multiple cache directories on different filesys‐\ntems, if you have several filesystems on which you use darcs.\n\n\ndarcs/prefs/boring\nThe `darcs/prefs/boring` file may contain a list of regular expressions describing files,\nsuch as object files, that you do not expect to add to your project. A newly created reposi‐\ntory has a boring file that includes many common source control, backup, temporary, and com‐\npiled files.\n\nYou may want to have the boring file under version control. To do this you can use darcs set‐\npref to set the value 'boringfile' to the name of your desired boring file (e.g. `darcs set‐\npref boringfile .boring`, where `.boring` is the repository path of a file that has been\ndarcs added to your repository). The boringfile preference overrides `darcs/prefs/boring`,\nso be sure to copy that file to the boringfile.\n\nYou can also set up a 'boring' regexps file in your home directory, named `~/.darcs/boring`,\nwhich will be used with all of your darcs repositories.\n\nAny file not already managed by darcs and whose repository path matches any of the boring\nregular expressions is considered boring. The boring file is used to filter the files pro‐\nvided to darcs add, to allow you to use a simple `darcs add newdir newdir/*` without acciden‐\ntally adding a bunch of object files. It is also used when the `--look-for-adds` flag is\ngiven to whatsnew or record. Note that once a file has been added to darcs, it is not consid‐\nered boring, even if it matches the boring file filter.\n\n\ndarcs/prefs/binaries\nThe `darcs/prefs/binaries` file may contain a list of regular expressions describing files\nthat should be treated as binary files rather than text files. Darcs automatically treats\nfiles containing characters `^Z` or `NULL` within the first 4096 bytes as being binary files.\nYou probably will want to have the binaries file under version control. To do this you can\nuse `darcs setpref` to set the value 'binariesfile' to the name of your desired binaries file\n(e.g. `darcs setpref binariesfile ./.binaries`, where `.binaries` is a file that has been\ndarcs added to your repository). As with the boring file, you can also set up a `~/.darcs/bi‐\nnaries` file if you like.\n\n\ndarcs/prefs/defaultrepo\nContains the URL of the default remote repository used by commands `pull`, `push`, `send` and\n`optimize relink`. Darcs edits this file automatically or when the flag `--set-default` is\nused.\n\n\ndarcs/prefs/tmpdir\nBy default temporary directories are created in `/tmp`, or if that doesn't exist, in `darcs`\n(within the current repo). This can be overridden by specifying some other directory in the\nfile `darcs/prefs/tmpdir` or the environment variable `$DARCSTMPDIR` or `$TMPDIR`.\n\n\ndarcs/prefs/prefs\nContains the preferences set by the command `darcs setprefs`. Do not edit manually.\n\n### BUGS\n\nAt http://bugs.darcs.net/ you can find a list of known bugs in Darcs. Unknown bugs can be\nreported at that site (after creating an account) or by emailing the report to\nbugs@darcs.net.\n\n### SEE ALSO\n\nThe Darcs website provides a lot of additional information. It can be found at\nhttp://darcs.net/\n\n### LICENSE\n\nDarcs is free software; you can redistribute it and/or modify it under the terms of the GNU\nGeneral Public License as published by the Free Software Foundation; either version 2, or (at\nyour option) any later version.\n\n\n\n2.14.5 (release) DARCS(1)\n\n" } ], "structuredContent": { "command": "DARCS", "section": "1", "mode": "man", "summary": "darcs - an advanced revision control system", "synopsis": "darcs command ...\nWhere the commands and their respective arguments are\ndarcs help [ [darcssubcommand]]\ndarcs initialize []\ndarcs add ...\ndarcs whatsnew [file|directory]...\ndarcs record [file|directory]...\ndarcs clone []\ndarcs pull [repository]...\ndarcs push [repository]\ndarcs move ... \ndarcs remove ...\ndarcs replace ...\ndarcs log [file|directory]...\ndarcs annotate [file|directory]\ndarcs diff [file|directory]...\ndarcs show contents [file]...", "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 19, "subsections": [ { "name": "darcs show dependencies", "lines": 1 }, { "name": "darcs show index", "lines": 1 }, { "name": "darcs show pristine", "lines": 1 }, { "name": "darcs show repo", "lines": 1 }, { "name": "darcs show authors", "lines": 1 }, { "name": "darcs show tags", "lines": 1 }, { "name": "darcs show patch-index", "lines": 2 }, { "name": "darcs unrevert", "lines": 3 }, { "name": "darcs rebase suspend", "lines": 1 }, { "name": "darcs rebase unsuspend", "lines": 1 }, { "name": "darcs rebase obliterate", "lines": 1 }, { "name": "darcs rebase log", "lines": 1 }, { "name": "darcs unrecord", "lines": 1 }, { "name": "darcs obliterate", "lines": 4 }, { "name": "darcs optimize clean", "lines": 1 }, { "name": "darcs optimize http", "lines": 1 }, { "name": "darcs optimize reorder", "lines": 1 }, { "name": "darcs optimize enable-patch-index", "lines": 1 }, { "name": "darcs optimize disable-patch-index", "lines": 1 }, { "name": "darcs optimize compress", "lines": 1 }, { "name": "darcs optimize uncompress", "lines": 1 }, { "name": "darcs optimize relink", "lines": 1 }, { "name": "darcs optimize pristine", "lines": 1 }, { "name": "darcs optimize upgrade", "lines": 1 }, { "name": "darcs dist", "lines": 1 }, { "name": "darcs repair", "lines": 1 }, { "name": "darcs convert export", "lines": 4 } ] }, { "name": "DESCRIPTION", "lines": 14, "subsections": [] }, { "name": "OPTIONS", "lines": 4, "subsections": [ { "name": "Selecting Patches:", "lines": 42 } ] }, { "name": "COMMANDS", "lines": 6, "subsections": [ { "name": "Most used/starting out:", "lines": 213 }, { "name": "Preparing patches before recording:", "lines": 70 }, { "name": "Querying the repository:", "lines": 68 }, { "name": "darcs show dependencies", "lines": 27 }, { "name": "darcs show index", "lines": 3 }, { "name": "darcs show pristine", "lines": 3 }, { "name": "darcs show repo", "lines": 15 }, { "name": "darcs show authors", "lines": 33 }, { "name": "darcs show tags", "lines": 5 }, { "name": "darcs show patch-index", "lines": 27 }, { "name": "Undoing and correcting:", "lines": 11 }, { "name": "darcs unrevert", "lines": 35 }, { "name": "darcs rebase suspend", "lines": 2 }, { "name": "darcs rebase unsuspend", "lines": 2 }, { "name": "darcs rebase obliterate", "lines": 2 }, { "name": "darcs rebase log", "lines": 13 }, { "name": "darcs unrecord", "lines": 5 }, { "name": "darcs obliterate", "lines": 8 }, { "name": "Direct modification of the repository:", "lines": 45 }, { "name": "Exchanging patches by e-mail:", "lines": 126 }, { "name": "Other commands:", "lines": 1 }, { "name": "darcs optimize clean", "lines": 1 }, { "name": "darcs optimize http", "lines": 4 }, { "name": "darcs optimize reorder", "lines": 3 }, { "name": "darcs optimize enable-patch-index", "lines": 2 }, { "name": "darcs optimize disable-patch-index", "lines": 1 }, { "name": "darcs optimize compress", "lines": 8 }, { "name": "darcs optimize uncompress", "lines": 8 }, { "name": "darcs optimize relink", "lines": 7 }, { "name": "darcs optimize pristine", "lines": 2 }, { "name": "darcs optimize upgrade", "lines": 9 }, { "name": "darcs dist", "lines": 36 }, { "name": "darcs repair", "lines": 20 }, { "name": "darcs convert export", "lines": 50 } ] }, { "name": "ENVIRONMENT", "lines": 1, "subsections": [ { "name": "HOME and APPDATA", "lines": 159 } ] }, { "name": "FILES", "lines": 134, "subsections": [] }, { "name": "BUGS", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "LICENSE", "lines": 7, "subsections": [] } ] } }