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

Last change on this file since 32807 was 32807, checked in by sjamaan, 5 years ago

Add a big honking warning to every egg for CHICKEN 3 to notify the viewer that CHICKEN 4 is the current release

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