diff options
Diffstat (limited to 'man/7')
| -rw-r--r-- | man/7/caretaker-setup.pod (renamed from man/7/pkg-setup.pod) | 6 | ||||
| -rw-r--r-- | man/7/caretaker.pod (renamed from man/7/pkg.pod) | 60 |
2 files changed, 33 insertions, 33 deletions
diff --git a/man/7/pkg-setup.pod b/man/7/caretaker-setup.pod index 1c0d7bf..d59a0a2 100644 --- a/man/7/pkg-setup.pod +++ b/man/7/caretaker-setup.pod @@ -1,17 +1,17 @@ =head1 NAME -pkg - Package root setup +caretaker - Package root setup =head1 PACKAGE ROOT First, you'll need to create a root directory (from now on PKG_ROOT) on the server which shall from now on host all your packages. -Then you need to put the pkg git repository into F<PKG_ROOT/pkg> - it's recommended +Then you need to put the caretaker git repository into F<PKG_ROOT/caretaker> - it's recommended to do this via git clone --bare. Copy the pkglist script (include/pkglist) to F<PKG_ROOT/pkglist>. Now you can add your own packages as git repos in PKG_ROOT. -To use pkg with your packages on a machine, download and execute +To use caretaker with your packages on a machine, download and execute the bootstrap script (include/bootstrap). diff --git a/man/7/pkg.pod b/man/7/caretaker.pod index 8288b54..bbef02d 100644 --- a/man/7/pkg.pod +++ b/man/7/caretaker.pod @@ -1,12 +1,12 @@ =head1 NAME -pkg - distributed dotfile and script manager, package format +caretaker - distributed dotfile and script manager, package format =head1 INTRO (if you prefer technical infos over historical blah-blah, skip this section) -Actually, pkg is just a pimped dotfile manager, which just happens to support +Actually, caretaker is just a pimped dotfile manager, which just happens to support a sort of packages, version control, automatic sym- and hardlinking, and which can also handle scripts and binaries. Oh, and it can cause serious brain damage. @@ -18,10 +18,10 @@ you could, if you wanted to) =head1 THE BASICS -pkg requires two directories in your home directory. B<~/bin> contains +caretaker requires two directories in your home directory. B<~/bin> contains symlinks to the executables shipped with your packages, and $PKG_DIR (B<~/packages> by default) contains the -packages themselves. B<~/bin> may also contain normal executables; pkg will +packages themselves. B<~/bin> may also contain normal executables; caretaker will not overwrite existing files. =head1 THE PACKAGE DIRECTORY @@ -36,32 +36,32 @@ It also contains a special directory, F<.collected> - see L</"COLLECTED PACKAGE All directories in $PKG_DIR must be valid git repositories which are not in the state of 'initial commit'. Dotfiles (directories starting with a .) are exempt -from this, they will be ignored by pkg. +from this, they will be ignored by caretaker. =head1 THE PACKAGE ROOT -The packages_root, in pkg referred to as $PKG_ROOT, is structured just like +The packages_root, in caretaker referred to as $PKG_ROOT, is structured just like the packages directory $PKG_DIR, except that it neither contains .list nor -.list-remote. The packages root is the central point where pkg fetches +.list-remote. The packages root is the central point where caretaker fetches packages from and pushes packages to. The package root should contain the pkglist script shipped in include/. -If it doesn't, PKGLIST_PATH in .pkg.conf must be set to the appropiate +If it doesn't, PKGLIST_PATH in .caretaker.conf must be set to the appropiate location on the package root host. =head1 THE PACKAGE LIST The package list lives in the files B<.list> and B<.list-remote> mentioned above. It's used to decide whether a package needs to be pulled / pushed. -Also, the 'pkg add' completion relies on .list-remote, and back in the days when -pkg supported more than one DVCS, it was used to determine which DVCS to use +Also, the 'caretaker add' completion relies on .list-remote, and back in the days when +caretaker supported more than one DVCS, it was used to determine which DVCS to use for which package. It consists of one line per package, each line containing three items separated by a single whitespace. The first item is the package name, the second one the repository type (DVCS), the third the current revision. Example: - pkg git 82d716d01dee0329af7df5e67b55558fe3ff1466 + caretaker git 82d716d01dee0329af7df5e67b55558fe3ff1466 The package list is generated by the script set in the config var $PKGLIST_PATH, by default F<include/pkglist>. Depending on $PKGLIST_LOCAL and $PKG_ROOT, it @@ -76,13 +76,13 @@ remote package list without having to use ssh. =head1 WHAT IS A PACKAGE? -Anything tracked with git can be used as package. However, as the purpose of pkg +Anything tracked with git can be used as package. However, as the purpose of caretaker is not to do your version control, you probably want to have at least one of the files and directories described below in it. =head1 PACKAGE STRUCTURE -Special (as in, mostly handled by pkg) directories and files in a package. +Special (as in, mostly handled by caretaker) directories and files in a package. Note that all files and directories mentioned here are optional. @@ -91,7 +91,7 @@ Note that all files and directories mentioned here are optional. =item bin/ The place for executables to be in the user's PATH. -pkg will automatically create symlinks in F<~/bin> pointing to the files +caretaker will automatically create symlinks in F<~/bin> pointing to the files in the package's F<bin/>. Also, if a file in F<bin/> contains valid POD, a manual will be generated out of it (see L</"COLLECTED PACKAGE FILES">) @@ -109,7 +109,7 @@ Scripts used by the package that don't belong into B<bin/>. Not treated speciall =item man/ -Manual files in POD format, separated by section (like man/7/pkg.pod). +Manual files in POD format, separated by section (like man/7/caretaker.pod). To be prepared for possible future support of other manual formats, it is recommended to postfix each file with .pod @@ -119,7 +119,7 @@ Files for inclusion into other packages. See L</"PROVIDES"> =item description -Package description for B<pkg info> +Package description for B<ct info> =item links @@ -128,7 +128,7 @@ Sym- and hardlink descriptions. See checklinks(1) =item Makefile If a Makefile is available, C<make> will be executed every time the package -is updated (pkg add/push/pull/refresh) +is updated (ct add/push/pull/refresh) =item prereqs @@ -144,7 +144,7 @@ Packages with a priority above 3 require user confirmation to be removed =head1 PREREQUISITES The prerequisites are stored in a package in the file F<prereqs>. -It as an ordinary shell script which is sourced by pkg's global post-update +It as an ordinary shell script which is sourced by caretaker's global post-update hook; so it will be sourced after pulling, pushing or refreshing a package. Note that the file will be sourced in function scope. It is recommended to @@ -177,12 +177,12 @@ Mark I<package> for installation Execute expression and automatically warn if it fails. In case of B<depend package>, automatically mark B<package> for installation if it isn't installed. -If a B<depend> fails, pkg will inform the user about it and wait for confirmation +If a B<depend> fails, caretaker will inform the user about it and wait for confirmation =item B<recommend> I<...>, B<suggest> I<...> Take the same arguments as B<depend>, but are of lower priority. -recommend only causes "info" messages, and suggest does not interrupt pkg +recommend only causes "info" messages, and suggest does not interrupt caretaker to make sure it's read by the user =back @@ -190,7 +190,7 @@ to make sure it's read by the user Additionally, the string parameters B<warn> and B<info> can be used to store messages. -After executing the prereqs script, pkg will print the content of +After executing the prereqs script, caretaker will print the content of these parameters and wait for confirmation. It will also offer to install packages marked by B<depend package> or B<recommend package>. @@ -206,7 +206,7 @@ of that hook to do something useful with the data in F<provides/>. =head1 HOOKS Hooks are little zsh snippets residing in $PKG_DIR/hooks -which are sourced from within pkg whenever needed. +which are sourced from within caretaker whenever needed. Currently, the following hooks exist: @@ -214,17 +214,17 @@ Currently, the following hooks exist: =item post-add -Sourced after a package was installed (e.g. with pkg add/pkg install) +Sourced after a package was installed (e.g. with ct add/ct install) =item post-update -Sourced after a package was updated (pkg pkg pull). +Sourced after a package was updated (ct pull). It is also sourced when adding a package (after post-add) and -when calling pkg refresh. +when calling ct refresh. =item pre-remove -Sourced before a package is removed (pkg remove) +Sourced before a package is removed (ct remove) =back @@ -233,7 +233,7 @@ Sourced before a package is removed (pkg remove) These files reside in F<$PKG_DIR/.collected> (subject to change). The directory is somewhat similar to F<~/bin> - it is automatically populated -by pkg. However, this one does not contain symlinks. +by caretaker. However, this one does not contain symlinks. Currently, it only contains the directory F<man/>, which holds the "compiled" manual pages from the packages (extracted from F<bin/> and F<man/>). @@ -242,10 +242,10 @@ provided by packages. =head1 GIT -B<pkg> uses git(1) as backend for storing and syncing package information. +B<caretaker> uses git(1) as backend for storing and syncing package information. It is not recommended to use branches other than "master". While they should work if GIT_USE_ORIGIN is set to 1 (the default), they will -most likely confuse pkg. +most likely confuse caretaker. =head1 AUTHOR @@ -253,4 +253,4 @@ Daniel Friesel E<lt>derf@derf.homelinux.orgE<gt> =head1 SEE ALSO -checklinks(1), pkg(1) +checklinks(1), ct(1) |