Goffi's cp, a fancy file copier
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

gcp.1 4.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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 "June 04, 2011"
  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 \-L, \-\-dereference
  64. always follow symbolic links in sources
  65. .TP
  66. .B \-P, \-\-no\-dereference
  67. never follow symbolic links in sources
  68. .TP
  69. .B \-f, \-\-force
  70. Overwrite existing files.
  71. .TP
  72. .B \-\-preserve=PRESERVE
  73. Keep specified attributes. Attributes can be mode, ownership and timestamps.
  74. When several attributes are passed, they need to be separated by commas. Note
  75. that timestamps preservation has some limits, see section LIMITS.
  76. .TP
  77. .B \-\-no\-fs\-fix
  78. Don't fix file system naming incompatibilities.
  79. .TP
  80. .B \-\-no\-progress
  81. Disable progress bar.
  82. .TP
  83. .B \-v, \-\-verbose
  84. Display what is being done.
  85. .SS "Sources saving"
  86. .TP
  87. .B \-\-sources\-save=SOURCES_SAVE
  88. Save the list of source files in a list named SOURCES_SAVE.
  89. .TP
  90. .B \-\-sources\-replace=SOURCES_REPLACE
  91. Save the list of source files in a list named SOURCES_REPLACE and
  92. replace it if it already exists.
  93. .TP
  94. .B \-\-sources\-load=SOURCES_LOAD
  95. Reuse the list of source file named SOURCES_LOAD.
  96. .TP
  97. .B \-\-sources\-del=SOURCES_DEL
  98. Delete the list of source files named SOURCES_DEL.
  99. .TP
  100. .B \-\-sources\-list
  101. List the names of source file lists.
  102. .TP
  103. .B \-\-sources\-full\-list
  104. List the names of source file lists, including their content.
  105. .SH EXIT STATUS
  106. The exit status can be:
  107. .IP \[bu] 2
  108. \fB0\fP if files have been copied correctly or if another instance of gcp is already running and will do the copy.
  109. .IP \[bu]
  110. \fB1\fP if at least one file has not been copied, or if something went wrong.
  111. .IP \[bu]
  112. \fB2\fP if all files have been copied but with some issues
  113. .SH LIMITS
  114. Timestamps preservation with \-\-preserve option is limited by the os python
  115. module on POSIX systems. Currently, python only returns timestamps in float
  116. format, which is a smaller precision than what POSIX provides. Progress on this
  117. issue can be seen at http://bugs.python.org/issue11457.
  118. .SH SEE ALSO
  119. .BR cp (1).
  120. .br
  121. .SH AUTHOR
  122. gcp was written by Jérôme Poisson <goffi@goffi.org>.
  123. .PP
  124. This manual page was written by Thomas Preud'homme <robotux@celest.fr>,
  125. for the Debian project (and may be used by others).