mirror of
https://github.com/zplug/zplug
synced 2025-04-06 07:39:12 +02:00
105 lines
2.1 KiB
Groff
105 lines
2.1 KiB
Groff
'\" t
|
|
.\" Title: zplug-depth
|
|
.\" Author: [see the "Authors" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 11/21/2016
|
|
.\" Manual: ZPLUG Manual
|
|
.\" Source: ZPLUG Manual
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ZPLUG\-DEPTH" "5" "11/21/2016" "ZPLUG Manual" "ZPLUG Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
zplug-depth \- The number of commits to include in the cloned repository
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fIzplug\fR \fI"username/reponame"\fR, \fIdepth:10\fR
|
|
.fi
|
|
.sp
|
|
.nf
|
|
The word \'package\' refers to the string in the format: "username/reponame"\&.
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
By using depth tag, you can create a shallow clone with a history truncated to the specified number of commits\&. Depth 0 means the whole history\&.
|
|
.sp
|
|
.it 1 an-trap
|
|
.nr an-no-space-flag 1
|
|
.nr an-break-flag 1
|
|
.br
|
|
.B Table\ \&1.\ \&zplug detph tag
|
|
.TS
|
|
allbox tab(:);
|
|
ltB ltB.
|
|
T{
|
|
Possive Values
|
|
T}:T{
|
|
Default value
|
|
T}
|
|
.T&
|
|
lt lt.
|
|
T{
|
|
.sp
|
|
(non\-negative number)
|
|
T}:T{
|
|
.sp
|
|
0
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
.sp
|
|
Besides, by using zstyle command, you can change default value:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$ zstyle ":zplug:tag" depth 10
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
Shallow clone:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$ zplug "b4b4r07/enhancd", \e
|
|
as:plugin, \e
|
|
use:enhancd\&.sh \e
|
|
depth:1
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBzplug(1)\fR
|
|
.SH "FURTHER DOCUMENTATION"
|
|
.sp
|
|
See the references in official wiki page to get started using zplug\&. The wiki may perhaps be overwhelming for first\-time users\&.
|
|
.SH "AUTHORS"
|
|
.sp
|
|
zplug was originally written by Masaki Ishiyama (a\&.k\&.a @b4b4r07)\&. Many people have contributed to it\&.
|
|
.SH "COPYING"
|
|
.sp
|
|
Copyright (C) 2015\-2016 Masaki Ishiyama
|
|
.sp
|
|
MIT License
|
|
.SH "REPORTING BUGS"
|
|
.sp
|
|
Report bugs to the zplug issues
|