Mercurial > gcp

comparison README @ 19:7eb698246bec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README: first draft
author Goffi <goffi@goffi.org>
date Tue, 28 Sep 2010 17:15:55 +0800
parents
children 8603fcb8615a
comparison
equal deleted inserted replaced
18:9d015d756c0f 19:7eb698246bec
1 gcp v0.1
2 (c) Jérôme Poisson aka Goffi 2010
3
4 gcp (Goffi's cp) is a files copier.
5
6
7 ** LICENSE **
8
9 gcp is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13
14 gcp is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with gcp. If not, see <http://www.gnu.org/licenses/>.
21
22
23
24 ** WTF ? **
25 gcp is a file copier, loosely inspired from cp, but with high level functionnalities like:
26 - progression indicator
27 - gcp continue coping even when there is an issue: he just skip the file with problem, and go on
28 - journalization: gcp write what he is doing, this allow to now which files where effectively copied
29 - fixing names to be compatible with the target filesystem (e.g. removing incompatible chars like "?" or "*" on vfat)
30 - if you launch a copy when an other is already running, the files are added to the first queue, this avoir you hard drive to move its head all the time
31 - files saving: you can keep track of files you have copied, and re-copy them later (useful when, for example, you always copy some free music to all your friends).
32 - gcp will be approximately option-compatible with cp (approximately because the behaviour is not exactly the same, see below)
33
34 /!\ WARNING /!\
35 gcp is at an early stage of development, and really experimental: use at your own risks !
36
37 ** How to use it ? **
38 Pretty much like cp (see gcp --help).
39 Please note that the behaviour is not exactly the same as cp, even if gcp want to be option-compatible. Mainly, the destination filenames can be changed (by default, can be deactivated).
40 gcp doesn't implement yet all the options from cp, but it's planed.
41
42 ** What's next ? **
43
44 Several improvment are already planed:
45 - copy queue management (moving copy order)
46 - advanced console interface
47 - notification (xmpp and maybe mail) when a long copy is finished
48 - retry for files which where not correctly copied
49 - badly encoded unicode filenames fix
50
51 ... and other are with a "maybe"
52 - graphic interface
53 - desktop (Kde, Gnome, XFCE, ...) integration
54
55 ** Credits **
56
57 A big big thank to the authors/contributors of...
58
59 progressbar:
60 gcp use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression.
61
62 GLib:
63 This heavily used library is used here for the main loop and event catchins, and for DBus also
64
65 DBus:
66 This excellent IPC is in the heart of gcp
67
68 python and its amazing standard library:
69 gcp was coded quickly for my own need thanks to this excellent and efficient language and its really huge standard library.
70
71 If I forgot any credit, please contact me (mail below) to fix it.
72
73
74 ** Contact **
75
76 You can contact me at goffi@goffi.org .
77 You'll find the latest version on my website: http://www.goffi.org (it's mainly in french, I will probably make a little part in english in the future).
78 You can also have a look to my other main projects (and maybe to the smaller ones too ;) ):
79 - lm (list movie): a tool to list movies using IMdB data, loosely inspired from ls
80 - SàT: my main project, a jabber/XMPP client, which is a brick to many others things I have in mind
81
82 Don't hesitate to give feedback :)