diff --git a/man/git-scp.1 b/man/git-scp.1 new file mode 100644 index 0000000..9a1c43f --- /dev/null +++ b/man/git-scp.1 @@ -0,0 +1,191 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "GIT\-SCP" "1" "December 2014" "" "Git Extras" +. +.SH "NAME" +\fBgit\-scp\fR \- Copy files to SSH comptabile \fBgit\-remote\fR +. +.SH "SYNOPSIS" +. +.nf + +`git scp` \-h|help|? +`git scp` [\.\.\.|\.\.\.] +`git rscp` [] +. +.fi +. +.SH "DESCRIPTION" +A convenient way to copy files from the current working tree to the working directory of a remote repository\. If a \fB\.\.\.\fR is provided, only files that has changed within the commit range will be copied\. +. +.P +Internally this script uses \fBrsync\fR and not \fBscp\fR as the name suggests\. +. +.P +\fBgit\-rscp\fR \- Copies specific files from the working directory of a remote repository to the current working directory\. +. +.SH "OPTIONS" + +. +.IP "" 4 +. +.nf + +The git remote where you want to copy your files\. +. +.fi +. +.IP "" 0 +. +.P +\.\.\. +. +.IP "" 4 +. +.nf + +Any commit, commit range or tree\. Uses `git\-diff`(1) +. +.fi +. +.IP "" 0 +. +.P +\.\.\. +. +.IP "" 4 +. +.nf + +The parameters, when given, are used to limit the diff to the named paths (you can give directory names and get diff for all files under them)\. +. +.fi +. +.IP "" 0 +. +.SH "GIT CONFIGS" +To sanitize files using \fBdos2unix\fR before copying files +. +.IP "" 4 +. +.nf + +$ git config \-\-global \-\-add extras\.scp\.sanitize dos2unix +. +.fi +. +.IP "" 0 +. +.P +You can run the files through PHP lint (i\.e\. \fBphp \-l\fR) before copying files +. +.IP "" 4 +. +.nf + +$ git config \-\-global \-\-add extras\.scp\.sanitize php_lint +. +.fi +. +.IP "" 0 +. +.SH "EXAMPLES" +Make sure you have \fBgit\-remote\fR(1) setup +. +.IP "" 4 +. +.nf + +$ git remote add staging myStagingServer:/var/www/html +. +.fi +. +.IP "" 0 +. +.P +Copy unstaged files to remote +. +.IP "" 4 +. +.nf + +$ git scp staging +. +.fi +. +.IP "" 0 +. +.P +Copy staged and unstaged files to remote +. +.IP "" 4 +. +.nf + +$ git scp staging HEAD +. +.fi +. +.IP "" 0 +. +.P +Copy files that has been changed in the last commit, plus any staged or unstaged files to remote +. +.IP "" 4 +. +.nf + +$ git scp staging HEAD~1 +. +.fi +. +.IP "" 0 +. +.P +Copy files that has been changed between now and a tag +. +.IP "" 4 +. +.nf + +$ git scp staging v1\.2\.3 +. +.fi +. +.IP "" 0 +. +.P +Copy specific files +. +.IP "" 4 +. +.nf + +$ git scp staging index\.html \.gitignore \.htaccess +. +.fi +. +.IP "" 0 +. +.P +Copy specific directory +. +.IP "" 4 +. +.nf + +$ git scp staging js/vendor/ +. +.fi +. +.IP "" 0 +. +.SH "AUTHOR" +Written by Chern Jie <\fIlim@chernjie\.com\fR> +. +.SH "REPORTING BUGS" +<\fIhttps://github\.com/chernjie/git\-extras/issues\fR> +. +.SH "SEE ALSO" +<\fIhttps://github\.com/tj/git\-extras\fR> diff --git a/man/git-scp.html b/man/git-scp.html new file mode 100644 index 0000000..8e611c9 --- /dev/null +++ b/man/git-scp.html @@ -0,0 +1,180 @@ + + + + + + git-scp(1) - Copy files to SSH comptabile <code>git-remote</code> + + + + +
+ + + +
    +
  1. git-scp(1)
    2. +
  2. Git Extras
    3. +
  3. git-scp(1)
    4. +
+ +

NAME

+

+ git-scp - Copy files to SSH comptabile git-remote +

+ +

SYNOPSIS

+ +
`git scp` -h|help|?
+`git scp` <remote> [<commits>...|<path>...]
+`git rscp` <remote> [<path>]
+
+ +

DESCRIPTION

+ +

A convenient way to copy files from the current working tree to the working directory of a remote repository. If a <commits>... is provided, only files that has changed within the commit range will be copied.

+ +

Internally this script uses rsync and not scp as the name suggests.

+ +

git-rscp - Copies specific files from the working directory of a remote repository to the current working directory.

+ +

OPTIONS

+ +

<remote>

+ +
The git remote where you want to copy your files.
+
+ +

<commits>...

+ +
Any commit, commit range or tree. Uses `git-diff`(1)
+
+ +

<path>...

+ +
The <paths> parameters, when given, are used to limit the diff to the named paths (you can give directory names and get diff for all files under them).
+
+ +

GIT CONFIGS

+ +

To sanitize files using dos2unix before copying files

+ +
$ git config --global --add extras.scp.sanitize dos2unix
+
+ +

You can run the files through PHP lint (i.e. php -l) before copying files

+ +
$ git config --global --add extras.scp.sanitize php_lint
+
+ +

EXAMPLES

+ +

Make sure you have git-remote(1) setup

+ +
$ git remote add staging myStagingServer:/var/www/html
+
+ +

Copy unstaged files to remote

+ +
$ git scp staging
+
+ +

Copy staged and unstaged files to remote

+ +
$ git scp staging HEAD
+
+ +

Copy files that has been changed in the last commit, plus any staged or unstaged files to remote

+ +
$ git scp staging HEAD~1
+
+ +

Copy files that has been changed between now and a tag

+ +
$ git scp staging v1.2.3
+
+ +

Copy specific files

+ +
$ git scp staging index.html .gitignore .htaccess
+
+ +

Copy specific directory

+ +
$ git scp staging js/vendor/
+
+ +

AUTHOR

+ +

Written by Chern Jie <lim@chernjie.com>

+ +

REPORTING BUGS

+ +

<https://github.com/chernjie/git-extras/issues>

+ +

SEE ALSO

+ +

<https://github.com/tj/git-extras>

+ + +
    +
  1. +
  2. December 2014
    3. +
  3. git-scp(1)
    4. +
+ +
+ + diff --git a/man/git-scp.md b/man/git-scp.md new file mode 100644 index 0000000..a136bcd --- /dev/null +++ b/man/git-scp.md @@ -0,0 +1,82 @@ +git-scp(1) -- Copy files to SSH comptabile `git-remote` +======================================================= + +## SYNOPSIS + + `git scp` -h|help|? + `git scp` [...|...] + `git rscp` [] + +## DESCRIPTION + +A convenient way to copy files from the current working tree to the working directory of a remote repository. If a `...` is provided, only files that has changed within the commit range will be copied. + +Internally this script uses `rsync` and not `scp` as the name suggests. + +`git-rscp` - Copies specific files from the working directory of a remote repository to the current working directory. + +## OPTIONS + + <remote> + + The git remote where you want to copy your files. + + <commits>... + + Any commit, commit range or tree. Uses `git-diff`(1) + + <path>... + + The parameters, when given, are used to limit the diff to the named paths (you can give directory names and get diff for all files under them). + +## GIT CONFIGS + + To sanitize files using `dos2unix` before copying files + + $ git config --global --add extras.scp.sanitize dos2unix + + You can run the files through PHP lint (i.e. `php -l`) before copying files + + $ git config --global --add extras.scp.sanitize php_lint + +## EXAMPLES + + Make sure you have `git-remote`(1) setup + + $ git remote add staging myStagingServer:/var/www/html + + Copy unstaged files to remote + + $ git scp staging + + Copy staged and unstaged files to remote + + $ git scp staging HEAD + + Copy files that has been changed in the last commit, plus any staged or unstaged files to remote + + $ git scp staging HEAD~1 + + Copy files that has been changed between now and a tag + + $ git scp staging v1.2.3 + + Copy specific files + + $ git scp staging index.html .gitignore .htaccess + + Copy specific directory + + $ git scp staging js/vendor/ + +## AUTHOR + +Written by Chern Jie <> + +## REPORTING BUGS + +<> + +## SEE ALSO + +<>