source: project/wiki/eggref/3/sbky @ 13621

Last change on this file since 13621 was 13621, checked in by sjamaan, 11 years ago

Move old chicken 3 eggs over to eggref/3

File size: 5.5 KB
Line 
1[[tags: egg]]
2
3== Introduction
4
5sbky is a Scheme implementation of Angel Ortega's minimalistic ''bky''
6version control system. For more information about the principles behind
7bky, see [[http://www.triptico/software/bky|the bky homepage]].
8
9sbky uses {{rsync(1)}} for transferring files and creating revisions.
10Each revision is stored as a complete copy of the working file tree,
11using hard links to save disk space.
12
13sbky has no notion of "adding" or "removing" files to the set of
14versioned files in the working copy. All files that are not explicitly
15ignored are saved. To ignore specific files, {{.cvsignore}} files
16are used as in {{cvs(1)}}, as {{rsync(1)}} directly supports this.
17
18== Usage
19
20  sbky [ -v | -h | -n ] COMMAND ARGUMENT ...
21 
22  -v                 show executed commands
23  -h                 show help
24  -n                 dry run - do not execute any commands
25
26== Commands
27
28  sbky help
29
30Shows a list of available commands.
31
32  sbky version
33
34Shows version of sbky program.
35
36  sbky init [ -b NAME | -m MSG ] ...
37
38Creates a new repository. Optionally a branch-name and a commit
39message can be specified.
40
41  sbky commit [ -b NAME | -m MSG | -n | FILE1 ... ]
42
43Commits the changes in the working copy by creating a new
44revision. Optionally a branch-name and commit message can be
45specified. If {{-n}} is given, then the last commit message is
46re-used. The alias {{ci}} may be also be used for this command.
47
48  sbky checkout -A | ID
49
50Reverts the working copy to a particular revision or the current HEAD
51revision, if {{-A}} is given. {{bky}} calls this operation {{update}}.
52
53  sbky diff [ ID | -p ID | ID ID ]
54
55Shows a diff between the working copy and a given revision, a given revision
56and its parent or two given revisions. If no revisions are given, then
57a diff between the last commit (HEAD) and the working copy is shown.
58
59  sbky status
60
61Lists modified or added files.
62
63  sbky log [ -l NUM | ID ]
64
65Shows the log messages of each revision, starting with the most
66recent revision or the revision given. If the option {{-l}} is
67specified, then at most {{NUM}} log entries are shown.
68
69  sbky tag [ TAG ]
70
71Creates a tag, a named symbolic link to a the current HEAD revision.
72If no tag name is specified, all existing tags are listed.
73
74  sbky branchname [ NAME ]
75
76Sets the current branch-name of the repository. The branch-name has
77no particular purpose and is currently used for documentation only.
78If no branchname is given on the command-line, then the current branchname
79(if any( will be shown.
80
81  sbky pull [ REPO ]
82
83Synchronizes the current repository with a remote repository at {{REPO}},
84which may be any {{rsync(1)}} target. The current repository will be an
85exact copy of the remote after this operation.
86
87  sbky push [ REPO ]
88
89Synchronizes a remote repository with the current repository. The remote
90repository will be an exact copy of the current after this operation.
91
92  sbky incoming [ REPO ]
93
94Lists which files would be added or modified when pulling from {{REPO}}.
95
96  sbky outgoing [ REPO ]
97
98Lists which files would be modified when pushing to {{REPO}}.
99
100  sbky export DIRECTORY
101
102Exports the working copy files to a given directory, without any
103administrative files.
104
105  sbky patchset [ ID ]
106
107Shows the log message and diff between the given revision and it's
108parent. If no revision is given, the most recent commit is taken.
109
110  sbky save [ DESTINATION ]
111
112Creates a gzipped {{tar(1)}} archive of the current repository and stores
113it at {{DESTINATION}}, which may be a directory name or tar file name.
114If no destination is given, the archive will be created in the current directory.
115
116  sbky restore SOURCE
117
118Synchronizes the current repository from a tarball at {{SOURCE}} (a directory
119or tar file name). This is equivalent to (and implemented as) unpacking the
120tarball in a temporary directory and pulling from it.
121
122== Authors
123
124Angel Ortega, translated to Scheme by [[felix winkelmann]]
125
126== Version
127
128; 0.1.5 : fixed wrongly named library call
129; 0.1.4 : added some safety checks
130; 0.1.3 : fixed missing wiki page and link to bky
131; 0.1.2 : Initial version
132
133== License
134
135 Copyright (c) 2007-2008, Felix L. Winkelmann
136 All rights reserved.
137
138 Redistribution and use in source and binary forms, with or without
139 modification, are permitted provided that the following conditions are met:
140
141   Redistributions of source code must retain the above copyright notice,
142     this list of conditions and the following disclaimer.
143   Redistributions in binary form must reproduce the above copyright notice,
144     this list of conditions and the following disclaimer in the
145     documentation and/or other materials provided with the distribution.
146   Neither the name of the author nor the names of its contributors may be
147     used to endorse or promote products derived from this software without
148     specific prior written permission.
149
150 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
151 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
153 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
154 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
155 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
156 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
157 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
158 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
159 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
160 POSSIBILITY OF SUCH DAMAGE.
Note: See TracBrowser for help on using the repository browser.