From 185008ae97960c8d551adcd9e23565194651b5d1 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 18 Sep 2006 02:47:29 +0000 Subject: [PATCH] Autogenerated man pages for v1.4.2.1-g80823 --- man1/git-apply.1 | 10 +- man1/git-pack-objects.1 | 129 ++++---- man1/git-repack.1 | 116 ++++---- man1/git-repo-config.1 | 642 +++++++++++++++++++++------------------- 4 files changed, 460 insertions(+), 437 deletions(-) diff --git a/man1/git-apply.1 b/man1/git-apply.1 index 47a5d09ad..d2ef8c75a 100755 --- a/man1/git-apply.1 +++ b/man1/git-apply.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-APPLY" "1" "09/14/2006" "" "" +.TH "GIT\-APPLY" "1" "09/18/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -72,6 +72,14 @@ Remove leading slashes from traditional diff paths. The default is 1. \-C Ensure at least lines of surrounding context match before and after each change. When fewer lines of surrounding context exist they all must match. By default no context is ever ignored. .TP +\-\-unidiff\-zero +By default, +\fBgit\-apply\fR(1) +expects that the patch being applied is a unified diff with at least one line of context. This provides good safety measures, but breaks down when applying a diff generated with \-\-unified=0. To bypass these checks use +\fI\-\-unidiff\-zero\fR. +.sp +Note, for the reasons stated above usage of context\-free patches are discouraged. +.TP \-\-apply If you use any of the options marked "Turns off \fIapply\fR" above, diff --git a/man1/git-pack-objects.1 b/man1/git-pack-objects.1 index 3862b62e6..4051cba0f 100755 --- a/man1/git-pack-objects.1 +++ b/man1/git-pack-objects.1 @@ -1,101 +1,86 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "GIT-PACK-OBJECTS" 1 "" "" "" -.SH NAME -git-pack-objects \- Create a packed archive of objects +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "GIT\-PACK\-OBJECTS" "1" "09/18/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-pack\-objects \- Create a packed archive of objects .SH "SYNOPSIS" - +.sp .nf \fIgit\-pack\-objects\fR [\-q] [\-\-no\-reuse\-delta] [\-\-non\-empty] [\-\-local] [\-\-incremental] [\-\-window=N] [\-\-depth=N] - {\-\-stdout | base\-name} < object\-list + [\-\-revs [\-\-unpacked | \-\-all]*] [\-\-stdout | base\-name] < object\-list .fi - .SH "DESCRIPTION" - - -Reads list of objects from the standard input, and writes a packed archive with specified base\-name, or to the standard output\&. - - -A packed archive is an efficient way to transfer set of objects between two repositories, and also is an archival format which is efficient to access\&. The packed archive format (\&.pack) is designed to be unpackable without having anything else, but for random access, accompanied with the pack index file (\&.idx)\&. - - -\fIgit\-unpack\-objects\fR command can read the packed archive and expand the objects contained in the pack into "one\-file one\-object" format; this is typically done by the smart\-pull commands when a pack is created on\-the\-fly for efficient network transport by their peers\&. - - -Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES) enables git to read from such an archive\&. - - -In a packed archive, an object is either stored as a compressed whole, or as a difference from some other object\&. The latter is often called a delta\&. - +Reads list of objects from the standard input, and writes a packed archive with specified base\-name, or to the standard output. +.sp +A packed archive is an efficient way to transfer set of objects between two repositories, and also is an archival format which is efficient to access. The packed archive format (.pack) is designed to be unpackable without having anything else, but for random access, accompanied with the pack index file (.idx). +.sp +\fIgit\-unpack\-objects\fR command can read the packed archive and expand the objects contained in the pack into "one\-file one\-object" format; this is typically done by the smart\-pull commands when a pack is created on\-the\-fly for efficient network transport by their peers. +.sp +Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES) enables git to read from such an archive. +.sp +In a packed archive, an object is either stored as a compressed whole, or as a difference from some other object. The latter is often called a delta. +.sp .SH "OPTIONS" - .TP base\-name -Write into a pair of files (\&.pack and \&.idx), using to determine the name of the created file\&. When this option is used, the two files are written in \-\&.{pack,idx} files\&. is a hash of object names (currently in random order so it does not have any useful meaning) to make the resulting filename reasonably unique, and written to the standard output of the command\&. - +Write into a pair of files (.pack and .idx), using to determine the name of the created file. When this option is used, the two files are written in \-.{pack,idx} files. is a hash of object names (currently in random order so it does not have any useful meaning) to make the resulting filename reasonably unique, and written to the standard output of the command. .TP \-\-stdout -Write the pack contents (what would have been written to \&.pack file) out to the standard output\&. - +Write the pack contents (what would have been written to .pack file) out to the standard output. +.TP +\-\-revs +Read the revision arguments from the standard input, instead of individual object names. The revision arguments are processed the same way as +\fBgit\-rev\-list\fR(1) +with +\-\-objects +flag uses its +commit +arguments to build the list of objects it outputs. The objects on the resulting list are packed. +.TP +\-\-unpacked +This implies +\-\-revs. When processing the list of revision arguments read from the standard input, limit the objects packed to those that are not already packed. +.TP +\-\-all +This implies +\-\-revs. In addition to the list of revision arguments read from the standard input, pretend as if all refs under +$GIT_DIR/refs +are specifed to be included. .TP \-\-window and \-\-depth -These two options affects how the objects contained in the pack are stored using delta compression\&. The objects are first internally sorted by type, size and optionally names and compared against the other objects within \-\-window to see if using delta compression saves space\&. \-\-depth limits the maximum delta depth; making it too deep affects the performance on the unpacker side, because delta data needs to be applied that many times to get to the necessary object\&. - +These two options affects how the objects contained in the pack are stored using delta compression. The objects are first internally sorted by type, size and optionally names and compared against the other objects within \-\-window to see if using delta compression saves space. \-\-depth limits the maximum delta depth; making it too deep affects the performance on the unpacker side, because delta data needs to be applied that many times to get to the necessary object. .TP \-\-incremental -This flag causes an object already in a pack ignored even if it appears in the standard input\&. - +This flag causes an object already in a pack ignored even if it appears in the standard input. .TP \-\-local -This flag is similar to \-\-incremental; instead of ignoring all packed objects, it only ignores objects that are packed and not in the local object store (i\&.e\&. borrowed from an alternate)\&. - +This flag is similar to +\-\-incremental; instead of ignoring all packed objects, it only ignores objects that are packed and not in the local object store (i.e. borrowed from an alternate). .TP \-\-non\-empty -Only create a packed archive if it would contain at least one object\&. - +Only create a packed archive if it would contain at least one object. .TP \-q -This flag makes the command not to report its progress on the standard error stream\&. - +This flag makes the command not to report its progress on the standard error stream. .TP \-\-no\-reuse\-delta -When creating a packed archive in a repository that has existing packs, the command reuses existing deltas\&. This sometimes results in a slightly suboptimal pack\&. This flag tells the command not to reuse existing deltas but compute them from scratch\&. - +When creating a packed archive in a repository that has existing packs, the command reuses existing deltas. This sometimes results in a slightly suboptimal pack. This flag tells the command not to reuse existing deltas but compute them from scratch. .SH "AUTHOR" - - -Written by Linus Torvalds - +Written by Linus Torvalds +.sp .SH "DOCUMENTATION" - - Documentation by Junio C Hamano - +.sp .SH "SEE ALSO" - - -\fBgit\-repack\fR(1) \fBgit\-prune\-packed\fR(1) - +\fBgit\-rev\-list\fR(1) \fBgit\-repack\fR(1) \fBgit\-prune\-packed\fR(1) +.sp .SH "GIT" - - Part of the \fBgit\fR(7) suite - +.sp diff --git a/man1/git-repack.1 b/man1/git-repack.1 index bbe8c4a0b..14593c452 100755 --- a/man1/git-repack.1 +++ b/man1/git-repack.1 @@ -1,84 +1,74 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "GIT-REPACK" 1 "" "" "" -.SH NAME -git-repack \- Script used to pack a repository from a collection of objects into pack files. +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "GIT\-REPACK" "1" "09/18/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-repack \- Script used to pack a repository from a collection of objects into pack files. .SH "SYNOPSIS" - - -\fIgit\-repack\fR [\-a] [\-d] [\-f] [\-l] [\-n] [\-q] - +\fIgit\-repack\fR [\-a] [\-d] [\-f] [\-l] [\-n] [\-q] [\-\-window=N] [\-\-depth=N] +.sp .SH "DESCRIPTION" - - -This script is used to combine all objects that do not currently reside in a "pack", into a pack\&. - - -A pack is a collection of objects, individually compressed, with delta compression applied, stored in a single file, with an associated index file\&. - - -Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc\&. - +This script is used to combine all objects that do not currently reside in a "pack", into a pack. +.sp +A pack is a collection of objects, individually compressed, with delta compression applied, stored in a single file, with an associated index file. +.sp +Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc. +.sp .SH "OPTIONS" - .TP \-a -Instead of incrementally packing the unpacked objects, pack everything available into a single pack\&. Especially useful when packing a repository that is used for a private development and there no need to worry about people fetching via dumb protocols from it\&. Use with \fI\-d\fR\&. - +Instead of incrementally packing the unpacked objects, pack everything available into a single pack. Especially useful when packing a repository that is used for a private development and there no need to worry about people fetching via dumb protocols from it. Use with +\fI\-d\fR. .TP \-d -After packing, if the newly created packs make some existing packs redundant, remove the redundant packs\&. Also runs \fBgit\-prune\-packed\fR(1)\&. - +After packing, if the newly created packs make some existing packs redundant, remove the redundant packs. Also runs +\fBgit\-prune\-packed\fR(1). .TP \-l -Pass the \-\-local option to git pack\-objects, see \fBgit\-pack\-objects\fR(1)\&. - +Pass the +\-\-local +option to +git pack\-objects, see +\fBgit\-pack\-objects\fR(1). .TP \-f -Pass the \-\-no\-reuse\-delta option to git pack\-objects, see \fBgit\-pack\-objects\fR(1)\&. - +Pass the +\-\-no\-reuse\-delta +option to +git pack\-objects, see +\fBgit\-pack\-objects\fR(1). .TP \-q -Pass the \-q option to git pack\-objects, see \fBgit\-pack\-objects\fR(1)\&. - +Pass the +\-q +option to +git pack\-objects, see +\fBgit\-pack\-objects\fR(1). .TP \-n -Do not update the server information with git update\-server\-info\&. - +Do not update the server information with +git update\-server\-info. +.TP +\-\-window=[N], \-\-depth=[N] +These two options affects how the objects contained in the pack are stored using delta compression. The objects are first internally sorted by type, size and optionally names and compared against the other objects within +\-\-window +to see if using delta compression saves space. +\-\-depth +limits the maximum delta depth; making it too deep affects the performance on the unpacker side, because delta data needs to be applied that many times to get to the necessary object. .SH "AUTHOR" - - -Written by Linus Torvalds - +Written by Linus Torvalds +.sp .SH "DOCUMENTATION" - - -Documentation by Ryan Anderson - +Documentation by Ryan Anderson +.sp .SH "SEE ALSO" - - \fBgit\-pack\-objects\fR(1) \fBgit\-prune\-packed\fR(1) - +.sp .SH "GIT" - - Part of the \fBgit\fR(7) suite - +.sp diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index aeb252435..4f83c51d0 100755 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-config.1 @@ -1,27 +1,16 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "GIT-REPO-CONFIG" 1 "" "" "" -.SH NAME -git-repo-config \- Get and set options in .git/config +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "GIT\-REPO\-CONFIG" "1" "09/18/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-repo\-config \- Get and set options in .git/config .SH "SYNOPSIS" - +.sp .nf \fIgit\-repo\-config\fR [type] name [value [value_regex]] \fIgit\-repo\-config\fR [type] \-\-replace\-all name [value [value_regex]] @@ -31,27 +20,21 @@ git-repo-config \- Get and set options in .git/config \fIgit\-repo\-config\fR [type] \-\-unset\-all name [value_regex] \fIgit\-repo\-config\fR \-l | \-\-list .fi - .SH "DESCRIPTION" - - -You can query/set/replace/unset options with this command\&. The name is actually the section and the key separated by a dot, and the value will be escaped\&. - - -If you want to set/unset an option which can occur on multiple lines, a POSIX regexp value_regex needs to be given\&. Only the existing values that match the regexp are updated or unset\&. If you want to handle the lines that do \fInot\fR match the regex, just prepend a single exclamation mark in front (see EXAMPLES)\&. - - -The type specifier can be either \fI\-\-int\fR or \fI\-\-bool\fR, which will make \fIgit\-repo\-config\fR ensure that the variable(s) are of the given type and convert the value to the canonical form (simple decimal number for int, a "true" or "false" string for bool)\&. If no type specifier is passed, no checks or transformations are performed on the value\&. - - +You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped. +.sp +If you want to set/unset an option which can occur on multiple lines, a POSIX regexp value_regex needs to be given. Only the existing values that match the regexp are updated or unset. If you want to handle the lines that do \fBnot\fR match the regex, just prepend a single exclamation mark in front (see EXAMPLES). +.sp +The type specifier can be either \fI\-\-int\fR or \fI\-\-bool\fR, which will make \fIgit\-repo\-config\fR ensure that the variable(s) are of the given type and convert the value to the canonical form (simple decimal number for int, a "true" or "false" string for bool). If no type specifier is passed, no checks or transformations are performed on the value. +.sp This command will fail if: - +.sp .TP 3 1. -The \&.git/config file is invalid, +The .git/config file is invalid, .TP 2. -Can not write to \&.git/config, +Can not write to .git/config, .TP 3. no section was provided, @@ -63,54 +46,40 @@ the section or key is invalid, you try to unset an option which does not exist, or .TP 6. -you try to unset/set an option for which multiple lines match\&. -.LP - +you try to unset/set an option for which multiple lines match. .SH "OPTIONS" - .TP \-\-replace\-all -Default behavior is to replace at most one line\&. This replaces all lines matching the key (and optionally the value_regex)\&. - +Default behavior is to replace at most one line. This replaces all lines matching the key (and optionally the value_regex). .TP \-\-get -Get the value for a given key (optionally filtered by a regex matching the value)\&. - +Get the value for a given key (optionally filtered by a regex matching the value). .TP \-\-get\-all -Like get, but does not fail if the number of values for the key is not exactly one\&. - +Like get, but does not fail if the number of values for the key is not exactly one. .TP \-\-get\-regexp -Like \-\-get\-all, but interprets the name as a regular expression\&. - +Like \-\-get\-all, but interprets the name as a regular expression. .TP \-\-unset -Remove the line matching the key from \&.git/config\&. - +Remove the line matching the key from .git/config. .TP \-\-unset\-all -Remove all matching lines from \&.git/config\&. - +Remove all matching lines from .git/config. .TP \-l, \-\-list -List all variables set in \&.git/config\&. - +List all variables set in .git/config. .SH "ENVIRONMENT" - .TP GIT_CONFIG -Take the configuration from the given file instead of \&.git/config\&. - +Take the configuration from the given file instead of .git/config. .TP GIT_CONFIG_LOCAL -Currently the same as $GIT_CONFIG; when Git will support global configuration files, this will cause it to take the configuration from the global configuration file in addition to the given file\&. - +Currently the same as $GIT_CONFIG; when Git will support global configuration files, this will cause it to take the configuration from the global configuration file in addition to the given file. .SH "EXAMPLE" - - -Given a \&.git/config like this: - +Given a .git/config like this: +.sp +.sp .nf # # This is the config file, and @@ -118,305 +87,376 @@ Given a \&.git/config like this: # a comment # .fi - +.sp .nf ; core variables [core] ; Don't trust file modes filemode = false .fi - +.sp .nf ; Our diff algorithm [diff] external = "/usr/local/bin/gnu\-diff \-u" renames = true .fi - +.sp .nf ; Proxy settings [core] - gitproxy="ssh" for "ssh://kernel\&.org/" - gitproxy="proxy\-command" for kernel\&.org + gitproxy="ssh" for "ssh://kernel.org/" + gitproxy="proxy\-command" for kernel.org gitproxy="myprotocol\-command" for "my://" gitproxy=default\-proxy ; for all the rest .fi - - you can set the filemode to true with - +.sp +.sp .nf -% git repo\-config core\&.filemode true +% git repo\-config core.filemode true .fi - - -The hypothetical proxy command entries actually have a postfix to discern what URL they apply to\&. Here is how to change the entry for kernel\&.org to "ssh"\&. - +The hypothetical proxy command entries actually have a postfix to discern what URL they apply to. Here is how to change the entry for kernel.org to "ssh". +.sp +.sp .nf -% git repo\-config core\&.gitproxy '"ssh" for kernel\&.org' 'for kernel\&.org$' +% git repo\-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' .fi - - -This makes sure that only the key/value pair for kernel\&.org is replaced\&. - - +This makes sure that only the key/value pair for kernel.org is replaced. +.sp To delete the entry for renames, do - +.sp +.sp .nf -% git repo\-config \-\-unset diff\&.renames +% git repo\-config \-\-unset diff.renames .fi - - -If you want to delete an entry for a multivar (like core\&.gitproxy above), you have to provide a regex matching the value of exactly one line\&. - - +If you want to delete an entry for a multivar (like core.gitproxy above), you have to provide a regex matching the value of exactly one line. +.sp To query the value for a given key, do - +.sp +.sp .nf -% git repo\-config \-\-get core\&.filemode +% git repo\-config \-\-get core.filemode .fi - - or - +.sp +.sp .nf -% git repo\-config core\&.filemode +% git repo\-config core.filemode .fi - - or, to query a multivar: - +.sp +.sp .nf -% git repo\-config \-\-get core\&.gitproxy "for kernel\&.org$" +% git repo\-config \-\-get core.gitproxy "for kernel.org$" .fi - - If you want to know all the values for a multivar, do: - +.sp +.sp .nf -% git repo\-config \-\-get\-all core\&.gitproxy +% git repo\-config \-\-get\-all core.gitproxy .fi - - -If you like to live dangerous, you can replace \fIall\fR core\&.gitproxy by a new one with - +If you like to live dangerous, you can replace \fBall\fR core.gitproxy by a new one with +.sp +.sp .nf -% git repo\-config \-\-replace\-all core\&.gitproxy ssh +% git repo\-config \-\-replace\-all core.gitproxy ssh .fi - - -However, if you really only want to replace the line for the default proxy, i\&.e\&. the one without a "for ..." postfix, do something like this: - +However, if you really only want to replace the line for the default proxy, i.e. the one without a "for \&..." postfix, do something like this: +.sp +.sp .nf -% git repo\-config core\&.gitproxy ssh '! for ' +% git repo\-config core.gitproxy ssh '! for ' .fi - - To actually match only values with an exclamation mark, you have to - +.sp +.sp .nf -% git repo\-config section\&.key value '[!]' +% git repo\-config section.key value '[!]' .fi - .SH "CONFIGURATION FILE" - - -The git configuration file contains a number of variables that affect the git command's behavior\&. They can be used by both the git plumbing and the porcelains\&. The variables are divided into sections, where in the fully qualified variable name the variable itself is the last dot\-separated segment and the section name is everything before the last dot\&. The variable names are case\-insensitive and only alphanumeric characters are allowed\&. Some variables may appear multiple times\&. - - -The syntax is fairly flexible and permissive; whitespaces are mostly ignored\&. The \fI#\fR and \fI;\fR characters begin comments to the end of line, blank lines are ignored, lines containing strings enclosed in square brackets start sections and all the other lines are recognized as setting variables, in the form \fIname = value\fR\&. If there is no equal sign on the line, the entire line is taken as \fIname\fR and the variable is recognized as boolean "true"\&. String values may be entirely or partially enclosed in double quotes; some variables may require special value format\&. - +The git configuration file contains a number of variables that affect the git command's behavior. They can be used by both the git plumbing and the porcelains. The variables are divided into sections, where in the fully qualified variable name the variable itself is the last dot\-separated segment and the section name is everything before the last dot. The variable names are case\-insensitive and only alphanumeric characters are allowed. Some variables may appear multiple times. +.sp +The syntax is fairly flexible and permissive; whitespaces are mostly ignored. The \fI#\fR and \fI;\fR characters begin comments to the end of line, blank lines are ignored, lines containing strings enclosed in square brackets start sections and all the other lines are recognized as setting variables, in the form \fIname = value\fR. If there is no equal sign on the line, the entire line is taken as \fIname\fR and the variable is recognized as boolean "true". String values may be entirely or partially enclosed in double quotes; some variables may require special value format. +.sp .SS "Example" - +.sp .nf # Core variables [core] ; Don't trust file modes filemode = false .fi - +.sp .nf # Our diff algorithm [diff] external = "/usr/local/bin/gnu\-diff \-u" renames = true .fi - .SS "Variables" - - -Note that this list is non\-comprehensive and not necessarily complete\&. For command\-specific variables, you will find a more detailed description in the appropriate manual page\&. You will find a description of non\-core porcelain configuration variables in the respective porcelain documentation\&. - -.TP -core\&.fileMode -If false, the executable bit differences between the index and the working copy are ignored; useful on broken filesystems like FAT\&. See \fBgit\-update\-index\fR(1)\&. True by default\&. - -.TP -core\&.gitProxy -A "proxy command" to execute (as \fIcommand host port\fR) instead of establishing direct connection to the remote server when using the git protocol for fetching\&. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string\&. This variable may be set multiple times and is matched in the given order; the first match wins\&. - -Can be overridden by the \fIGIT_PROXY_COMMAND\fR environment variable (which always applies universally, without the special "for" handling)\&. - -.TP -core\&.ignoreStat -The working copy files are assumed to stay unchanged until you mark them otherwise manually \- Git will not detect the file changes by lstat() calls\&. This is useful on systems where those are very slow, such as Microsoft Windows\&. See \fBgit\-update\-index\fR(1)\&. False by default\&. - -.TP -core\&.preferSymlinkRefs -Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links\&. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link\&. - -.TP -core\&.logAllRefUpdates -If true, git\-update\-ref will append a line to "$GIT_DIR/logs/" listing the new SHA1 and the date/time of the update\&. If the file does not exist it will be created automatically\&. This information can be used to determine what commit was the tip of a branch "2 days ago"\&. This value is false by default (no logging)\&. - -.TP -core\&.repositoryFormatVersion -Internal variable identifying the repository format and layout version\&. - -.TP -core\&.sharedRepository -When \fIgroup\fR (or \fItrue\fR), the repository is made shareable between several users in a group (making sure all the files and objects are group\-writable)\&. When \fIall\fR (or \fIworld\fR or \fIeverybody\fR), the repository will be readable by all users, additionally to being group\-shareable\&. When \fIumask\fR (or \fIfalse\fR), git will use permissions reported by umask(2)\&. See \fBgit\-init\-db\fR(1)\&. False by default\&. - -.TP -core\&.warnAmbiguousRefs -If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the \&.git/refs/ tree\&. True by default\&. - -.TP -core\&.compression -An integer \-1\&.\&.9, indicating the compression level for objects that are not in a pack file\&. \-1 is the zlib and git default\&. 0 means no compression, and 1\&.\&.9 are various speed/size tradeoffs, 9 being slowest\&. - -.TP -core\&.legacyheaders -A boolean which enables the legacy object header format in case you want to interoperate with old clients accessing the object database directly (where the "http://" and "rsync://" protocols count as direct access)\&. - -.TP -alias\&.* -Command aliases for the \fBgit\fR(1) command wrapper \- e\&.g\&. after defining "alias\&.last = cat\-file commit HEAD", the invocation "git last" is equivalent to "git cat\-file commit HEAD"\&. To avoid confusion and troubles with script usage, aliases that hide existing git commands are ignored\&. Arguments are split by spaces, the usual shell quoting and escaping is supported\&. quote pair and a backslash can be used to quote them\&. - -.TP -apply\&.whitespace -Tells git\-apply how to handle whitespaces, in the same way as the \fI\-\-whitespace\fR option\&. See \fBgit\-apply\fR(1)\&. - -.TP -pager\&.color -A boolean to enable/disable colored output when the pager is in use (default is true)\&. - -.TP -diff\&.color -When true (or always), always use colors in patch\&. When false (or never), never\&. When set to auto, use colors only when the output is to the terminal\&. - -.TP -diff\&.color\&. -Use customized color for diff colorization\&. specifies which part of the patch to use the specified color, and is one of plain (context text), meta (metainformation), frag (hunk header), old (removed lines), or new (added lines)\&. The value for these configuration variables can be one of: normal, bold, dim, ul, blink, reverse, reset, black, red, green, yellow, blue, magenta, cyan, or white\&. - -.TP -diff\&.renameLimit -The number of files to consider when performing the copy/rename detection; equivalent to the git diff option \fI\-l\fR\&. - -.TP -diff\&.renames -Tells git to detect renames\&. If set to any boolean value, it will enable basic rename detection\&. If set to "copies" or "copy", it will detect copies, as well\&. - -.TP -format\&.headers -Additional email headers to include in a patch to be submitted by mail\&. See \fBgit\-format\-patch\fR(1)\&. - -.TP -gitcvs\&.enabled -Whether the cvs pserver interface is enabled for this repository\&. See \fBgit\-cvsserver\fR(1)\&. - -.TP -gitcvs\&.logfile -Path to a log file where the cvs pserver interface well... logs various stuff\&. See \fBgit\-cvsserver\fR(1)\&. - -.TP -http\&.sslVerify -Whether to verify the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_NO_VERIFY\fR environment variable\&. - -.TP -http\&.sslCert -File containing the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CERT\fR environment variable\&. - -.TP -http\&.sslKey -File containing the SSL private key when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_KEY\fR environment variable\&. - -.TP -http\&.sslCAInfo -File containing the certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CAINFO\fR environment variable\&. - -.TP -http\&.sslCAPath -Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CAPATH\fR environment variable\&. - -.TP -http\&.maxRequests -How many HTTP requests to launch in parallel\&. Can be overridden by the \fIGIT_HTTP_MAX_REQUESTS\fR environment variable\&. Default is 5\&. - -.TP -http\&.lowSpeedLimit, http\&.lowSpeedTime -If the HTTP transfer speed is less than \fIhttp\&.lowSpeedLimit\fR for longer than \fIhttp\&.lowSpeedTime\fR seconds, the transfer is aborted\&. Can be overridden by the \fIGIT_HTTP_LOW_SPEED_LIMIT\fR and \fIGIT_HTTP_LOW_SPEED_TIME\fR environment variables\&. - -.TP -i18n\&.commitEncoding -Character encoding the commit messages are stored in; git itself does not care per se, but this information is necessary e\&.g\&. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other porcelains)\&. See e\&.g\&. \fBgit\-mailinfo\fR(1)\&. Defaults to \fIutf\-8\fR\&. - -.TP -merge\&.summary -Whether to include summaries of merged commits in newly created merge commit messages\&. False by default\&. - -.TP -pack\&.window -The size of the window used by \fBgit\-pack\-objects\fR(1) when no window size is given on the command line\&. Defaults to 10\&. - -.TP -pull\&.octopus -The default merge strategy to use when pulling multiple branches at once\&. - -.TP -pull\&.twohead -The default merge strategy to use when pulling a single branch\&. - -.TP -show\&.difftree -The default \fBgit\-diff\-tree\fR(1) arguments to be used for \fBgit\-show\fR(1)\&. - -.TP -showbranch\&.default -The default set of branches for \fBgit\-show\-branch\fR(1)\&. See \fBgit\-show\-branch\fR(1)\&. - -.TP -tar\&.umask -By default, \fBgit\-tar\-tree\fR(1) sets file and directories modes to 0666 or 0777\&. While this is both useful and acceptable for projects such as the Linux Kernel, it might be excessive for other projects\&. With this variable, it becomes possible to tell \fBgit\-tar\-tree\fR(1) to apply a specific umask to the modes above\&. The special value "user" indicates that the user's current umask will be used\&. This should be enough for most projects, as it will lead to the same permissions as \fBgit\-checkout\fR(1) would use\&. The default value remains 0, which means world read\-write\&. - -.TP -user\&.email -Your email address to be recorded in any newly created commits\&. Can be overridden by the \fIGIT_AUTHOR_EMAIL\fR and \fIGIT_COMMITTER_EMAIL\fR environment variables\&. See \fBgit\-commit\-tree\fR(1)\&. - -.TP -user\&.name -Your full name to be recorded in any newly created commits\&. Can be overridden by the \fIGIT_AUTHOR_NAME\fR and \fIGIT_COMMITTER_NAME\fR environment variables\&. See \fBgit\-commit\-tree\fR(1)\&. - -.TP -whatchanged\&.difftree -The default \fBgit\-diff\-tree\fR(1) arguments to be used for \fBgit\-whatchanged\fR(1)\&. - +Note that this list is non\-comprehensive and not necessarily complete. For command\-specific variables, you will find a more detailed description in the appropriate manual page. You will find a description of non\-core porcelain configuration variables in the respective porcelain documentation. +.sp +.TP +core.fileMode +If false, the executable bit differences between the index and the working copy are ignored; useful on broken filesystems like FAT. See +\fBgit\-update\-index\fR(1). True by default. +.TP +core.gitProxy +A "proxy command" to execute (as +\fIcommand host port\fR) instead of establishing direct connection to the remote server when using the git protocol for fetching. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string. This variable may be set multiple times and is matched in the given order; the first match wins. +.sp +Can be overridden by the +\fIGIT_PROXY_COMMAND\fR +environment variable (which always applies universally, without the special "for" handling). +.TP +core.ignoreStat +The working copy files are assumed to stay unchanged until you mark them otherwise manually \- Git will not detect the file changes by lstat() calls. This is useful on systems where those are very slow, such as Microsoft Windows. See +\fBgit\-update\-index\fR(1). False by default. +.TP +core.preferSymlinkRefs +Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link. +.TP +core.logAllRefUpdates +If true, +git\-update\-ref +will append a line to "$GIT_DIR/logs/" listing the new SHA1 and the date/time of the update. If the file does not exist it will be created automatically. This information can be used to determine what commit was the tip of a branch "2 days ago". This value is false by default (no logging). +.TP +core.repositoryFormatVersion +Internal variable identifying the repository format and layout version. +.TP +core.sharedRepository +When +\fIgroup\fR +(or +\fItrue\fR), the repository is made shareable between several users in a group (making sure all the files and objects are group\-writable). When +\fIall\fR +(or +\fIworld\fR +or +\fIeverybody\fR), the repository will be readable by all users, additionally to being group\-shareable. When +\fIumask\fR +(or +\fIfalse\fR), git will use permissions reported by umask(2). See +\fBgit\-init\-db\fR(1). False by default. +.TP +core.warnAmbiguousRefs +If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the .git/refs/ tree. True by default. +.TP +core.compression +An integer \-1..9, indicating the compression level for objects that are not in a pack file. \-1 is the zlib and git default. 0 means no compression, and 1..9 are various speed/size tradeoffs, 9 being slowest. +.TP +core.legacyheaders +A boolean which enables the legacy object header format in case you want to interoperate with old clients accessing the object database directly (where the "http://" and "rsync://" protocols count as direct access). +.TP +alias.* +Command aliases for the +\fBgit\fR(1) +command wrapper \- e.g. after defining "alias.last = cat\-file commit HEAD", the invocation "git last" is equivalent to "git cat\-file commit HEAD". To avoid confusion and troubles with script usage, aliases that hide existing git commands are ignored. Arguments are split by spaces, the usual shell quoting and escaping is supported. quote pair and a backslash can be used to quote them. +.TP +apply.whitespace +Tells +git\-apply +how to handle whitespaces, in the same way as the +\fI\-\-whitespace\fR +option. See +\fBgit\-apply\fR(1). +.TP +pager.color +A boolean to enable/disable colored output when the pager is in use (default is true). +.TP +diff.color +When true (or +always), always use colors in patch. When false (or +never), never. When set to +auto, use colors only when the output is to the terminal. +.TP +diff.color. +Use customized color for diff colorization. + +specifies which part of the patch to use the specified color, and is one of +plain +(context text), +meta +(metainformation), +frag +(hunk header), +old +(removed lines), or +new +(added lines). The value for these configuration variables can be one of: +normal, +bold, +dim, +ul, +blink, +reverse, +reset, +black, +red, +green, +yellow, +blue, +magenta, +cyan, or +white. +.TP +diff.renameLimit +The number of files to consider when performing the copy/rename detection; equivalent to the git diff option +\fI\-l\fR. +.TP +diff.renames +Tells git to detect renames. If set to any boolean value, it will enable basic rename detection. If set to "copies" or "copy", it will detect copies, as well. +.TP +format.headers +Additional email headers to include in a patch to be submitted by mail. See +\fBgit\-format\-patch\fR(1). +.TP +gitcvs.enabled +Whether the cvs pserver interface is enabled for this repository. See +\fBgit\-cvsserver\fR(1). +.TP +gitcvs.logfile +Path to a log file where the cvs pserver interface well\&... logs various stuff. See +\fBgit\-cvsserver\fR(1). +.TP +http.sslVerify +Whether to verify the SSL certificate when fetching or pushing over HTTPS. Can be overridden by the +\fIGIT_SSL_NO_VERIFY\fR +environment variable. +.TP +http.sslCert +File containing the SSL certificate when fetching or pushing over HTTPS. Can be overridden by the +\fIGIT_SSL_CERT\fR +environment variable. +.TP +http.sslKey +File containing the SSL private key when fetching or pushing over HTTPS. Can be overridden by the +\fIGIT_SSL_KEY\fR +environment variable. +.TP +http.sslCAInfo +File containing the certificates to verify the peer with when fetching or pushing over HTTPS. Can be overridden by the +\fIGIT_SSL_CAINFO\fR +environment variable. +.TP +http.sslCAPath +Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS. Can be overridden by the +\fIGIT_SSL_CAPATH\fR +environment variable. +.TP +http.maxRequests +How many HTTP requests to launch in parallel. Can be overridden by the +\fIGIT_HTTP_MAX_REQUESTS\fR +environment variable. Default is 5. +.TP +http.lowSpeedLimit, http.lowSpeedTime +If the HTTP transfer speed is less than +\fIhttp.lowSpeedLimit\fR +for longer than +\fIhttp.lowSpeedTime\fR +seconds, the transfer is aborted. Can be overridden by the +\fIGIT_HTTP_LOW_SPEED_LIMIT\fR +and +\fIGIT_HTTP_LOW_SPEED_TIME\fR +environment variables. +.TP +i18n.commitEncoding +Character encoding the commit messages are stored in; git itself does not care per se, but this information is necessary e.g. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other porcelains). See e.g. +\fBgit\-mailinfo\fR(1). Defaults to +\fIutf\-8\fR. +.TP +merge.summary +Whether to include summaries of merged commits in newly created merge commit messages. False by default. +.TP +pack.window +The size of the window used by +\fBgit\-pack\-objects\fR(1) +when no window size is given on the command line. Defaults to 10. +.TP +pull.octopus +The default merge strategy to use when pulling multiple branches at once. +.TP +pull.twohead +The default merge strategy to use when pulling a single branch. +.TP +show.difftree +The default +\fBgit\-diff\-tree\fR(1) +arguments to be used for +\fBgit\-show\fR(1). +.TP +showbranch.default +The default set of branches for +\fBgit\-show\-branch\fR(1). See +\fBgit\-show\-branch\fR(1). +.TP +status.color +A boolean to enable/disable color in the output of +\fBgit\-status\fR(1). May be set to +true +(or +always), +false +(or +never) or +auto, in which case colors are used only when the output is to a terminal. Defaults to false. +.TP +status.color. +Use customized color for status colorization. + +is one of +header +(the header text of the status message), +updated +(files which are updated but not committed), +changed +(files which are changed but not updated in the index), or +untracked +(files which are not tracked by git). The values of these variables may be specified as in diff.color.. +.TP +tar.umask +By default, +\fBgit\-tar\-tree\fR(1) +sets file and directories modes to 0666 or 0777. While this is both useful and acceptable for projects such as the Linux Kernel, it might be excessive for other projects. With this variable, it becomes possible to tell +\fBgit\-tar\-tree\fR(1) +to apply a specific umask to the modes above. The special value "user" indicates that the user's current umask will be used. This should be enough for most projects, as it will lead to the same permissions as +\fBgit\-checkout\fR(1) +would use. The default value remains 0, which means world read\-write. +.TP +user.email +Your email address to be recorded in any newly created commits. Can be overridden by the +\fIGIT_AUTHOR_EMAIL\fR +and +\fIGIT_COMMITTER_EMAIL\fR +environment variables. See +\fBgit\-commit\-tree\fR(1). +.TP +user.name +Your full name to be recorded in any newly created commits. Can be overridden by the +\fIGIT_AUTHOR_NAME\fR +and +\fIGIT_COMMITTER_NAME\fR +environment variables. See +\fBgit\-commit\-tree\fR(1). +.TP +whatchanged.difftree +The default +\fBgit\-diff\-tree\fR(1) +arguments to be used for +\fBgit\-whatchanged\fR(1). .TP imap -The configuration variables in the \fIimap\fR section are described in \fBgit\-imap\-send\fR(1)\&. - +The configuration variables in the +\fIimap\fR +section are described in +\fBgit\-imap\-send\fR(1). .SH "AUTHOR" - - -Written by Johannes Schindelin - +Written by Johannes Schindelin +.sp .SH "DOCUMENTATION" - - -Documentation by Johannes Schindelin, Petr Baudis and the git\-list \&. - +Documentation by Johannes Schindelin, Petr Baudis and the git\-list . +.sp .SH "GIT" - - Part of the \fBgit\fR(7) suite - +.sp -- 2.26.2