cpet/openbsd-ports
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document fetch-all, getpkgpath, link-checksum, portslogger

Browse Source
This commit is contained in:
espie 2010-09-13 11:31:42 +00:00
parent b8fc8e6548
commit 1ee3d54881
4 changed files with 200 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
infrastructure/man/man1/fetch-all.1 Normal file
View File

@ -0,0 +1,48 @@
.\" $OpenBSD: fetch-all.1,v 1.1 2010/09/13 11:31:42 espie Exp $
.\"
.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: September 13 2010 $
.Dt FETCH-ALL 1
.Os
.Sh NAME
.Nm fetch-all
.Nd fetches distfiles for ports.
.Sh SYNOPSIS
.Nm fetch-all
.Ar distfile
.Sh DESCRIPTION
.Nm
is a helper script for use within
.Pa ${PORTSDIR}/distfiles/Makefile .
.Pp
It fetches the file
.Ar distfile
using information from environment variables
.Ev SITES
(a list of urls from which to retrieve the file),
.Ev CIPHER
(the name of the checksum algorithm to use)
and
.Ev CKSUM
(the actual value to match).
.Pp
In case none of the sites carries the appropriate distfile,
.Nm
will error out, after displaying a message urging the user to
contact
.Ev MAINTAINER .
.Sh SEE ALSO
.Xr mirroring-ports 7 .

38
infrastructure/man/man1/getpkgpath.1 Normal file
View File

@ -0,0 +1,38 @@
.\" $OpenBSD: getpkgpath.1,v 1.1 2010/09/13 11:31:42 espie Exp $
.\"
.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: September 13 2010 $
.Dt GETPKGPATH 1
.Os
.Sh NAME
.Nm getpkgpath
.Nd deduces
.Ev PKGPATH
from current directory
.Sh SYNOPSIS
.Nm getpkgpath
.Ar dir
.Sh DESCRIPTION
.Nm
deduces the
.Ev PKGPATH
corresponding to a given directory
.Ar dir ,
by trying to strip directories from the environment variable
.Ev PORTSDIR_PATH .
.Pp
This is mostly a helper script for
.Pa bsd.port.subdir.mk .

51
infrastructure/man/man1/link-checksums.1 Normal file
View File

@ -0,0 +1,51 @@
.\" $OpenBSD: link-checksums.1,v 1.1 2010/09/13 11:31:42 espie Exp $
.\"
.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: September 13 2010 $
.Dt LINK-CHECKSUMS 1
.Os
.Sh NAME
.Nm link-checksums
.Nd creates by-cipher links for distfiles
.Sh SYNOPSIS
.Nm link-checksums
.Sh DESCRIPTION
.Nm
is a helper script for use within
.Pa /usr/ports/distfiles
for people running distfiles mirrors.
.Pp
.Nm
will create hardlinks between distfiles and corresponding checksums;
those will in turn be used by the ports infrastructure, when running
.Sq make fetch REFETCH=true .
.Pp
.Nm
scans directory
.Ev DISTDIR
.Po
by default,
.Pa /usr/ports/distfiles
.Pc
and creates hardlinks for each checksum algorithm in
.Ev CIPHERS
(by default, sha1 md5 rmd160 sha256),
such as
.Pa by_cipher/md5/8506fd205028a96c741e4037de6e3c42 .
.Sh SEE ALSO
.Xr cksum 1 ,
.Xr bsd.port.mk 5 ,
.Xr mirroring-ports 7 .

63
infrastructure/man/man1/portslogger.1 Normal file
View File

@ -0,0 +1,63 @@
.\" $OpenBSD: portslogger.1,v 1.1 2010/09/13 11:31:42 espie Exp $
.\"
.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: September 13 2010 $
.Dt PORTSLOGGER 1
.Os
.Sh NAME
.Nm portslogger
.Nd logs ports builds selectively
.Sh SYNOPSIS
.Nm porslogger
.Op Fl s
.Ar directory
.Sh DESCRIPTION
.Nm
saves logs from ports build in separate files.
.Pp
.Nm
handles directory change messages from the ports tree infrastructure and
switches to a corresponding log file situated in
.Ar directory
accordingly, e.g., it will log the build from screen in
.Pa directory/screen-4.0.3p1.log .
.Nm
will filter progress-bar noise from
.Xr ftp 1 ,
.Xr pkg_add 1 ,
and
.Xr pkg_create 1 .
.Pp
By default,
.Nm
acts as a filter and still passes its input to stdout, unless
run with
.Fl s .
.Pp
It is most often used as
.Bd -literal -offset indent
make package 2>&1 | portslogger logdir
.Ed
.Pp
or in conjunction with
.Xr tmux 1 ,
such as
.Bd -literal -offset indent
tmux pipe-pane 'portslogger -s logdir'
.Ed
.Sh SEE ALSO
.Xr dpb 1 ,
.Xr tmux 1 .