From 5c9f2db4d96cd40016c5cabdb2997ce5e22bc6bc Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 23 Feb 2006 11:21:44 +0000 Subject: [PATCH] Autogenerated man pages for v1.2.2-g9821 --- man1/git-cvsserver.1 | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++ man1/git-rm.1 | 94 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 197 insertions(+) create mode 100755 man1/git-cvsserver.1 create mode 100755 man1/git-rm.1 diff --git a/man1/git-cvsserver.1 b/man1/git-cvsserver.1 new file mode 100755 index 00000000..fcfa83b6 --- /dev/null +++ b/man1/git-cvsserver.1 @@ -0,0 +1,103 @@ +.\"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-CVSSERVER" 1 "" "" "" +.SH NAME +git-cvsserver \- A CVS server emulator for git +.SH "SYNOPSIS" + +.nf +export CVS_SERVER=git\-cvsserver +\fIcvs\fR \-d :ext:user@server/path/repo\&.git co +.fi + +.SH "DESCRIPTION" + + +This application is a CVS emulation layer for git\&. + + +It is highly functional\&. However, not all methods are implemented, and for those methods that are implemented, not all switches are implemented\&. + + +Testing has been done using both the CLI CVS client, and the Eclipse CVS plugin\&. Most functionality works fine with both of these clients\&. + +.SH "LIMITATIONS" + + +Currently gitcvs only works over ssh connections\&. + +.SH "INSTALLATION" + +.TP 3 +1. +Put server\&.pl somewhere useful on the same machine that is hosting your git repos +.TP +2. +For each repo that you want accessible from CVS you need to edit config in the repo and add the following section\&. + +.nf +[gitcvs] + enabled=1 + logfile=/path/to/logfile +.fi + +.nf +n\&.b\&. you need to ensure each user that is going to invoke server\&.pl has +write access to the log file\&. +.fi +.TP +3. +On each client machine you need to set the following variables\&. CVSROOT should be set as per normal, but the directory should point at the appropriate git repo\&. CVS_SERVER should be set to the server\&.pl script that has been put on the remote machine\&. +.TP +4. +Clients should now be able to check out modules (where modules are the names of branches in git)\&. $ cvs co \-d mylocaldir master +.LP + +.SH "OPERATIONS SUPPORTED" + + +All the operations required for normal use are supported, including checkout, diff, status, update, log, add, remove, commit\&. Legacy monitoring operations are not supported (edit, watch and related)\&. Exports and tagging (tags and branches) are not supported at this stage\&. + + +The server will set the \-k mode to binary when relevant\&. In proper GIT tradition, the contents of the files are always respected\&. No keyword expansion or newline munging is supported\&. + +.SH "DEPENDENCIES" + + +git\-cvsserver depends on DBD::SQLite\&. + +.SH "COPYRIGHT AND AUTHORS" + + +This program is copyright The Open University UK \- 2006\&. + + +Authors: Martyn Smith Martin Langhoff with ideas and patches from participants of the git\-list \&. + +.SH "DOCUMENTATION" + + +Documentation by Martyn Smith and Martin Langhoff Matthias Urlichs \&. + +.SH "GIT" + + +Part of the \fBgit\fR(7) suite + diff --git a/man1/git-rm.1 b/man1/git-rm.1 new file mode 100755 index 00000000..c961df37 --- /dev/null +++ b/man1/git-rm.1 @@ -0,0 +1,94 @@ +.\"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-RM" 1 "" "" "" +.SH NAME +git-rm \- Remove files from the working tree and from the index. +.SH "SYNOPSIS" + + +\fIgit\-rm\fR [\-f] [\-n] [\-v] [\-\-] ... + +.SH "DESCRIPTION" + + +A convenience wrapper for git\-update\-index \-\-remove\&. For those coming from cvs, git\-rm provides an operation similar to "cvs rm" or "cvs remove"\&. + +.SH "OPTIONS" + +.TP +... +Files to remove from the index and optionally, from the working tree as well\&. + +.TP +\-f +Remove files from the working tree as well as from the index\&. + +.TP +\-n +Don't actually remove the file(s), just show if they exist in the index\&. + +.TP +\-v +Be verbose\&. + +.TP +-- +This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options)\&. + +.SH "DISCUSSION" + + +The list of given to the command is fed to git\-ls\-files command to list files that are registered in the index and are not ignored/excluded by $GIT_DIR/info/exclude file or \&.gitignore file in each directory\&. This means two things: + +.TP 3 +1. +You can put the name of a directory on the command line, and the command will remove all files in it and its subdirectories (the directories themselves are never removed from the working tree); +.TP +2. +Giving the name of a file that is not in the index does not remove that file\&. +.LP + +.SH "EXAMPLES" + +.TP +git\-rm Documentation/\\*\&.txt +Removes all *\&.txt files from the index that are under the Documentation directory and any of its subdirectories\&. The files are not removed from the working tree\&. + +Note that the asterisk * is quoted from the shell in this example; this lets the command include the files from subdirectories of Documentation/ directory\&. + +.TP +git\-rm \-f git\-*\&.sh +Remove all git\-*\&.sh scripts that are in the index\&. The files are removed from the index, and (because of the \-f option), from the working tree as well\&. Because this example lets the shell expand the asterisk (i\&.e\&. you are listing the files explicitly), it does not remove subdir/git\-foo\&.sh\&. + +.SH "AUTHOR" + + +Written by Linus Torvalds + +.SH "DOCUMENTATION" + + +Documentation by Junio C Hamano and the git\-list \&. + +.SH "GIT" + + +Part of the \fBgit\fR(7) suite + -- 2.11.0