docs/tf.txt

   1 tf(1)
   2 =====
   3
   4 NAME
   5 ----
   6 tf - Team Foundation Client
   7
   8
   9 SYNOPSIS
  10 --------
  11 'tf' [/server:<server name or ip address>] [/login:<login credentials>]
  12                 <command> [<command arguments>]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 'tf' is a source control client for Microsoft Team Foundation Server.
  18
  19 OPTIONS
  20 -------
  21 */login*:username[,password]::
  22         Provide authentication credentials. If you don't specify a
  23   password you will be prompted for one. If you have
  24   gnome-keyring support enabled, TF will store the login
  25   credentials on your default keyring if configured to do so
  26         (see "Credentials.Save" configuration option below).
  27
  28 */server*:<server name or ip address>::
  29         Specify the Team Foundation Server. If you are within a mapped
  30   working folder, you don't need to specify the /server option,
  31   as this information is stored in the VersionControl.config
  32   cache file.
  33
  34 COMMANDS
  35 --------
  36 *add <filenames>*::
  37         Pend an add on a file or files to the repository. To commit, you
  38   must issue a checkin command.
  39
  40 *changeset <changeset id>*::
  41         Show changeset details: committer, date, comment, and files changed.
  42         The changeset id is just an integer - no "C" prefix is required as in
  43         the diff command below.
  44
  45 *checkin [ <filenames or path> /recursive ]*::
  46         Checkin pending changes in workspace. With no arguments, this command
  47   will checkin all files in your workspace, not just all files underneath
  48   your current working directory.
  49
  50 *checkout <filenames>*::
  51   Checkout a file for editing. Command alias: edit.
  52
  53 *configure [ <key> | <key> <value> ]*::
  54         With no arguments, displays current configuration. With 1 argument,
  55         deletes the configuration setting <key>. With 2 arguments,
  56         sets the value of <key> to <value>. See Configuration section below
  57   for more details on valid settings.
  58
  59 *delete <filenames> [ /recursive ]*::
  60   Pend a delete against a file or files from the repository. To commit, you
  61   must issue a checkin command.
  62
  63 *diff <filename or path or changeset id> [ /old | /modified ]*::
  64   Show pending changes as a diff. With /old, shows changes from current
  65   workspace to latest on the server as a diff. With /modified, shows
  66         changes to writable workspace files as a diff - another way to preview
  67         changes before using the *online* command. With a changeset id, like
  68   C12278, the command will show you a diff of the files changed in that
  69   changeset.
  70
  71 *dir <server path>*::
  72   List files in specified server path. A way to explore the folders on the server
  73   without setting up a workspace and downloading the files.
  74
  75 *get [ <path> ]*::
  76   Update local repository with latest versions from the server.
  77         Think "cvs/svn update". Note: Files are initially set to read-only, until
  78   checked out with the *checkout* command.
  79
  80 *history <filename | path > [ /format:detailed /recursive ]*::
  81         Display changelog history for specified file. If you are looking for a
  82         git-log/svn log type function use this and add /recursive.
  83
  84 *labels [ <labelname> /owner:<ownername> /format:detailed ]*::
  85         Displays labels or tags. Can optionally filter by <labelname> and <ownername>.
  86
  87 *ls-files <path> [ /deleted | /modified | /old | /unknown ]*::
  88         Shows known, deleted, modified, old, or unknown files under the given path.
  89         With no options, ls-files shows known files. /old option by default shows
  90   only files in your workspace which are out of date, not new files on the
  91   server you've not yet fetched. To show those files as well, use "/old /all".
  92   This behavior may change in future releases, based on user feedback.
  93
  94 *online <path> [ /added | /modified | /deleted | /preview ]*::
  95   Finds all writable files and marks them as pending changes on the server.
  96         It also finds all unknown files and marks them as pending adds, missing
  97   files are marked as pending deletes. A great command to use if you apply
  98         a patch to a clean tfs-managed tree and want to pend the changes to the
  99         server for checkin. The /added, /modified, /deleted flags can be used
 100         to show just additions, just modifications, or just deletions respectively.
 101         These flags may be combined. With no flags, all changes are shown.
 102
 103 *perm <filename>*::
 104         Show server permissions on a file. Command alias: permission.
 105
 106 *properties <filenames> [ /recursive ]*::
 107         Show detailed properties for each filename including server locks, encoding,
 108   last modified date, changeset id, and whether the file has a newer version
 109   on the server.
 110
 111 *rename <oldname> <newname>*::
 112         Rename a file or files in the repository.
 113
 114 *status [<filenames> /recursive ]*::
 115   Show status of all pending changes in local workspace. Optional paths/filenames
 116         may be added to narrow the resulting output.
 117
 118 *treeclean*::
 119   Delete all files not under version control. Use /preview to see what
 120         would be deleted.
 121
 122 *undo* <filenames> [ /recursive ]::
 123   Undo pending changes.
 124
 125 *workspace* [ /new | /delete ]::
 126   Manage workspaces.
 127
 128 *workspaces [ /format:detailed ]*::
 129         List workspaces in server repository. Use /format:detailed for additional
 130   information.
 131
 132 *workfold [ <server path> <local path> | /unmap <local path> ]*::
 133   Manage working folders. With no arguments, print current working folder
 134   mappings. With a server path and local path, creates a new working folder
 135   mapping.
 136
 137 *view <filenames | server paths>*::
 138         Displays the latest version of the specified file or files.
 139
 140 EXAMPLES
 141 --------
 142
 143 * List all workspaces on the server 10.2.10.2, using a username of
 144   "domain\\username" and a password of "password".
 145
 146 ------------
 147 $  tf workspaces /server:10.2.10.2 /login:domain\\username,password \
 148      /owner:"*" /computer:"*"
 149 ------------
 150
 151 * Create a workspace with the name "workspaceName" with an owner name of ownerName
 152
 153 ------------
 154 $  tf workspace /new "workspaceName;ownerName"
 155 ------------
 156
 157 * Setup a working folder for the project "ProjectName" in directory ~/src/project
 158
 159 ------------
 160 $  tf workfold "$/ProjectName" /home/username/src/project
 161 ------------
 162
 163 * Fetch/Get all files in folder in project "ProjectName" to local machine.
 164
 165 ------------
 166 $  tf get /recursive /home/username/src/project
 167 ------------
 168
 169 * Delete the workspace "workspaceName" created above.
 170
 171 ------------
 172 $  tf workspace /delete workspaceName
 173 ------------
 174
 175
 176 MULTIPLE COMMANDS
 177 -----------------
 178 You can execute multiple commands in sequence in a single run of TF,
 179 by separating the commands with '%'. Here's how you might checkin a
 180 patch with a single run of TF:
 181
 182 ------------
 183 $  patch -p1 < ~/new-feature.diff
 184 $  tf online % checkin
 185 ------------
 186
 187
 188 CONFIGURATION
 189 -------------
 190 The TF client stores configuration settings in ~/.tf/TfClient.config.
 191
 192 *Checkin.Validate*::
 193         The TF client will display a summary of pending
 194   changes and ask for confirmaton below committing changes to the server
 195   when set to "true". The default is "false". It's non-trivial to rollback
 196   a committed change, so this option is highly recommended.
 197
 198 *Checkout.Latest*::
 199   The TF client will always checkout the latest version rather than
 200   the workspace version if this setting is set to "true". Note: this option
 201         only effects the checkout command, not the "online" command.
 202
 203 *Credentials.Save*::
 204         The TF client will store login credentials if this
 205   setting is set to "true". The default is "false".
 206
 207 *File.Excludes*::
 208         A comma separated list of files to ignore. Currently, only the "online"
 209         command honors this setting. The wildcard characters * and ? are supported.
 210         Example setting: "*.dll,*.pdb".
 211
 212 *Get.Recursive*::
 213         The TF client will automatically do recursive gets when set
 214         to "true". IMHO, this is far more useful than the default       behavior.
 215
 216 *History.DefaultToCwd*::
 217         The TF client will default to the current working directory if not options
 218         are given when running the subcommand "history". The default behavior of the
 219         standard client is to require a path for all history queries. This option
 220   provides an optional and more sensible default.
 221
 222 *History.Recursive*::
 223         The TF client will automatically do recursive history queries when set
 224         to "true". IMHO, this is far more useful than the default       behavior.
 225
 226 *Online.Recursive*::
 227         The TF client will automatically do a recursive online command when set
 228         to "true". IMHO, this is far more useful than the default       behavior for
 229         clean trees. Not as helpful for trees littered with build output files.
 230
 231
 232 WORKSPACE CACHE
 233 ---------------
 234 The TF client keeps a cache of workspaces and folder mappings in
 235 ~/.tf/Cache/VersionControl.config. Here's a sample file:
 236
 237 ------------
 238 <VersionControlServer>
 239   <Servers>
 240     <ServerInfo uri="http://10.2.1.2:8080/">
 241       <WorkspaceInfo name="neo" ownerName="DOMAIN\USER" computer="MYBOX" comment="" LastSavedCheckinTimeStamp="4/26/2007 11:55:50 PM">
 242         <MappedPaths>
 243           <MappedPath path="/home/jreed/Source/xyz-project" />
 244           <MappedPath path="/home/jreed/Source/abc-project" />
 245         </MappedPaths>
 246       </WorkspaceInfo>
 247     </ServerInfo>
 248   </Servers>
 249 </VersionControlServer>
 250 ------------
 251
 252
 253 IMPLEMENTATION NOTES
 254 --------------------
 255 TFS doesn't have built in support for tracking file attributes, for
 256 example, whether the file is executable or not. The TF client included
 257 in this package makes use of libmagic to determine whether a file
 258 should be marked executable or not.
 259
 260
 261 MORE INFORMATION
 262 ----------------
 263 http://groups.google.com/group/tf4mono
 264 http://msdn2.microsoft.com/en-us/library/bb130146(VS.80).aspx
 265 http://msdn2.microsoft.com/en-us/teamsystem/default.aspx
 266 http://msdn2.microsoft.com/en-us/cc31bk2e(VS.80).aspx
 267
 268
 269 AUTHOR
 270 ------
 271 Written by Joel Reed <joelwreed@gmail.com>
 272
 273
 274 DOCUMENTATION
 275 --------------
 276 Documentation by Joel Reed <joelwreed@gmail.com>
 277