Document daemon command
[TortoiseGit.git] / doc / source / en / TortoiseGit / tsvn_dug / dug_settings_git.xml
blobf10e15e8ba03362a4d7140de0daedc6c8ca5eb8a
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect2 id="tsvn-dug-settings-git">\r
4         <title>Git</title>\r
5         <sect3 id="tsvn-dug-settings-config">\r
6                 <title>Config</title>\r
7                 <?dbhh topicname="HIDD_SETTINGIT_CONFIG"?>\r
8                 <para>\r
9                         <figure id="tsvn-dug-settings-git-config">\r
10                                 <title>The Settings Dialog, Config</title>\r
11                                 <graphic fileref="../images/SettingsGitConfig.png"/>\r
12                         </figure>\r
13                 </para>\r
14                 <para> Set git basic configuration </para>\r
15                 <para> <guilabel>AutoCrlf</guilabel>\r
16                         If true, makes git convert CRLF at the end of lines in text files\r
17                         to LF when reading from the filesystem, and convert in reverse when\r
18                         writing to the filesystem. The variable can be set to input,\r
19                         in which case the conversion happens only while reading from\r
20                         the filesystem but files are written out with LF at the end of lines. \r
21                         A file is considered "text" (i.e. be subjected to the autocrlf mechanism) \r
22                         based on the file's crlf attribute, or if crlf is unspecified, \r
23                         based on the file's contents.\r
24                 </para>\r
25                 <para> <guilabel>SafeCrlf</guilabel>\r
26                         If true, makes git check if converting CRLF as controlled by core.autocrlf is reversible.\r
27                         Git will verify if a command modifies a file in the work tree either directly or indirectly. \r
28                         For example, committing a file followed by checking out the same file should yield the original file in the work tree. \r
29                         If this is not the case for the current setting of core.autocrlf, git will reject the file. \r
30                         The variable can be set to "warn", \r
31                         in which case git will only warn about an irreversible conversion but continue the operation.\r
32                 </para>\r
33                 <para> <guilabel>Save as Global</guilabel>\r
34                         For writing options: write to global ~/.gitconfig file rather than the repository .git/config.\r
35                 </para>\r
36         </sect3>\r
37         <sect3 id="tsvn-dug-settings-remote">\r
38                 <title>Remote</title>\r
39                 <?dbhh topicname="HIDD_SETTINREMOTE"?>\r
40                 <para>\r
41                         <figure id="tsvn-dug-settings-git-remote">\r
42                                 <title>The Settings Dialog, Remote</title>\r
43                                 <graphic fileref="../images/SettingsGitRemote.png"/>\r
44                         </figure>\r
45                 </para>\r
46                 <para> Set git remote configuration </para>\r
47                 <para>\r
48                         <guilabel>Remote</guilabel>\r
49                         The name of the remote, usually the default one is called 'origin'.\r
50                 </para>\r
51                 <para>\r
52                         <guilabel>URL</guilabel>\r
53                         The URL of the remote. It can be http / https / ssh / git protocol or local file system.\r
54                         Note that for local file system, the path should use forward slash '/'; and\r
55                         for absolute path, use /C/Project1 for C:\Project1.\r
56                 </para>\r
57                 <para>\r
58                         <guilabel>Putty Key</guilabel>\r
59                         The putty key file to load when performing network operations.\r
60                 </para>\r
61                 <para>\r
62                         <guilabel>Tag</guilabel>\r
63                         This sets remote.name.tagopt config, which controls the default tag fetching behaviour of the specified remote.\r
64                         Reachable: Download tags that are reachable from remote branch heads (default behaviour).\r
65                         None: No tags are downloaded (--no-tags).\r
66                         All tags only: Only all tags are downloaded but no branches are downloaded (--tags).\r
67                 </para>\r
68         </sect3>\r
69         <sect3 id="tsvn-dug-settings-credential">\r
70                 <title>Credential</title>\r
71                 <?dbhh topicname="HIDD_SETTINCREDENTIAL"?>\r
72                 <para>\r
73                         <figure id="tsvn-dug-settings-git-credential">\r
74                                 <title>The Settings Dialog, Credential</title>\r
75                                 <graphic fileref="../images/SettingsGitCredential.png"/>\r
76                         </figure>\r
77                 </para>\r
78                 <para>Set simple credential helper configuration</para>\r
79                 <para>\r
80                         <guilabel>Advanced</guilabel>\r
81                         This is used if the credential helper configuration does not match any simple settings.\r
82                         If you choose other than Advanced, except the corrsponding credential.helper, all other config keys credential.* or credential.*.* are removed.\r
83                 </para>\r
84                 <para>\r
85                         <guilabel>None</guilabel>\r
86                         No credential config keys are in all config levels.\r
87                 </para>\r
88                 <para>\r
89                         <guilabel>wincred - this repository only</guilabel>\r
90                         wincred is enabled in local config.\r
91                         This option is visible only if wincred is installed.\r
92                 </para>\r
93                 <para>\r
94                         <guilabel>winstore - this repository only</guilabel>\r
95                         winstore is enabled in local config.\r
96                         This option is visible only if winstore is installed for current Windows user.\r
97                 </para>\r
98                 <para>\r
99                         <guilabel>wincred - current Windows user</guilabel>\r
100                         wincred is enabled in global config.\r
101                         This option is visible only if wincred is installed.\r
102                 </para>\r
103                 <para>\r
104                         <guilabel>winstore - current Windows user</guilabel>\r
105                         winstore is enabled in global config.\r
106                         This option is visible only if winstore is installed for current Windows user.\r
107                 </para>\r
108                 <para>\r
109                         <guilabel>wincred - all Windows users</guilabel>\r
110                         wincred is enabled in system config.\r
111                         This option is visible only if wincred is installed.\r
112                 </para>\r
113                 <para>Advanced credential helper configuration</para>\r
114                 <para>\r
115                         <guilabel>Config type</guilabel>\r
116                         Either Local, Global or System config.\r
117                 </para>\r
118                 <para>\r
119                         <guilabel>URL</guilabel>\r
120                         Define a context-specific configuration based on URL pattern. By default, the path component is not considered as a different context.\r
121                 </para>\r
122                 <para>\r
123                         <guilabel>Helper</guilabel>\r
124                         Select a credential helper program.\r
125                         wincred and winstore are predefined in TortoiseGit.\r
126                         It is possible to use other credential helpers or with extra options.\r
127                 </para>\r
128                 <para>\r
129                         <guilabel>Username</guilabel>\r
130                         A default username, if one is not provided in the URL. \r
131                 </para>\r
132                 <para>\r
133                         <guilabel>Use HTTP path component</guilabel>\r
134                         Also considers the path component of URL to match the configuration context.\r
135                 </para>\r
136                 <para>\r
137                         You can find more information at <xref linkend="gitcredentials(7)"/>.\r
138                 </para>\r
139         </sect3>\r
140 </sect2>