comparison gcp.1 @ 42:671d8c70a84c

manpage
author Thomas Preud'homme <thomas.preudhomme@celest.fr>
date Sat, 04 Jun 2011 19:44:36 +0200
parents
children d26ffbbcbdad
comparison
equal deleted inserted replaced
41:b54e5a4102da 42:671d8c70a84c
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH GCP 1 "November 22, 2010"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 gcp \- Advanced command-line file copier
20 .SH SYNOPSIS
21 .B gcp
22 .RI [ OPTIONS ]
23 .I FILE DEST
24 .br
25 .B gcp
26 .RI [ OPTIONS ]
27 .I FILE1
28 .RI [ FILE2 ... ]
29 .I DEST-DIR
30 .SH DESCRIPTION
31 This manual page documents briefly the
32 .B gcp
33 command.
34 .PP
35 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
36 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
37 .\" respectively.
38 \fBgcp\fP is a file copier, loosely inspired by cp, but with high level functionalities like:
39 \- transfer progression indication
40 \- continuous copying when there is an issue: it skips the problematic file and goes on
41 \- copy status logging: which files were effectively copied
42 \- name mangling to handle target filesystem limitations (e.g. removing incompatible chars like "?" or "*" on vfat)
43 \- forced copy serialization: new files to copy are added to a global queue to avoid hard drive head seeks
44 \- transfer list management: gcp can save a list of files to copy and reuse it later
45 \- approximate option compatibility with cp (approximate because the behaviour is not exactly the same, see below)
46 .SH OPTIONS
47 These programs follow the usual GNU command line syntax, with long
48 options starting with two dashes (`-').
49 By default, calling gcp is equivalent to calling gcp \-\-preserve=mode,ownership,timestamps.
50 .PP
51 A summary of options is included below.
52 .SS "General options"
53 .TP
54 .B \-\-version
55 Show version of program and exit.
56 .TP
57 .B \-h, \-\-help
58 Show summary of options.
59 .TP
60 .B \-r, \-\-recursive
61 Copy directories recursively.
62 .TP
63 .B \-f, \-\-force
64 Overwrite existing files.
65 .TP
66 .B \-\-preserve=PRESERVE
67 Keep specified attributes. Attributes can be mode, ownership and timestamps.
68 When several attributes are passed, they need to be separated by commas. Note
69 that timestamps preservation has some limits, see section LIMITS.
70 .TP
71 .B \-\-no\-fs\-fix
72 Don't fix file system naming incompatibilities.
73 .TP
74 .B \-\-no\-progress
75 Disable progress bar.
76 .TP
77 .B \-v, \-\-verbose
78 Display what is being done.
79 .SS "Sources saving"
80 .TP
81 .B \-\-sources\-save=SOURCES_SAVE
82 Save the list of source files in a list named SOURCES_SAVE.
83 .TP
84 .B \-\-sources\-replace=SOURCES_REPLACE
85 Save the list of source files in a list named SOURCES_REPLACE and
86 replace it if it already exists.
87 .TP
88 .B \-\-sources\-load=SOURCES_LOAD
89 Reuse the list of source file named SOURCES_LOAD.
90 .TP
91 .B \-\-sources\-del=SOURCES_DEL
92 Delete the list of source files named SOURCES_DEL.
93 .TP
94 .B \-\-sources\-list
95 List the names of source file lists.
96 .TP
97 .B \-\-sources\-full\-list
98 List the names of source file lists, including their content.
99 .SH LIMITS
100 Timestamps preservation with \-\-preserve option is limited by the os python
101 module on POSIX systems. Currently, python only returns timestamps in float
102 format, which is a smaller precision than what POSIX provides. Progress on this
103 issue can be seen at http://bugs.python.org/issue11457.
104 .SH SEE ALSO
105 .BR cp (1).
106 .br
107 .SH AUTHOR
108 gcp was written by Jérôme Poisson <goffi@goffi.org>.
109 .PP
110 This manual page was written by Thomas Preud'homme <robotux@celest.fr>,
111 for the Debian project (and may be used by others).