Ver a proveniência

Various documentation fixes.

Reported by: @delphij
tags/1.4.0
Alexandre Perrin há 5 anos
committed by Baptiste Daroussin
ascendente
cometimento
537384201d
17 ficheiros alterados com 67 adições e 72 eliminações
  1. +2
    -2
      FAQ.md
  2. +8
    -8
      README.md
  3. +2
    -2
      docs/GOALS
  4. +2
    -2
      docs/pkg-create.8
  5. +2
    -2
      docs/pkg-delete.8
  6. +7
    -7
      docs/pkg-query.8
  7. +2
    -2
      docs/pkg-repo.8
  8. +3
    -3
      docs/pkg-repository.5
  9. +6
    -6
      docs/pkg-search.8
  10. +3
    -3
      docs/pkg-set.8
  11. +2
    -2
      docs/pkg-shell.8
  12. +2
    -2
      docs/pkg-shlib.8
  13. +2
    -3
      docs/pkg-upgrade.8
  14. +6
    -7
      docs/pkg.8
  15. +10
    -12
      docs/pkg.conf.5
  16. +2
    -2
      docs/pkg_printf.3
  17. +6
    -7
      docs/pkg_repos.3

+ 2
- 2
FAQ.md Ver ficheiro

@@ -92,12 +92,12 @@ The documented (README) way to create a new repository creates all packages in o

This is different from earlier repository format, which creates it in separate directories.

Pkgng doesn not depend on a hierarchy, it recursively finds the packages from the provided directory entry.
Pkgng does not depend on a hierarchy, it recursively finds the packages from the provided directory entry.

<a name="9"></a>
### Q: Does `pkg repo` include symlinked packages?

The default hierarchy has lots of symlinks which should just be ignored and thus pkgng doesn not read symlinks.
The default hierarchy has lots of symlinks which should just be ignored and thus pkgng does not read symlinks.

<a name="10"></a>
### Q: How do I know if I have packages with the same origin?


+ 8
- 8
README.md Ver ficheiro

@@ -82,7 +82,7 @@ information about the package:
groups: [GROUP1, GROUP2]
options: { OPT1: off, OPT2: on }
desc: |-
This is the descrpition
This is the description
Of foo
A component of bar
@@ -170,7 +170,7 @@ show pkg-message, ...
remote FTP/HTTP server.

If only a package name is given, it will search the repository catalogues
and download and install the package if it exists. Anydependencies will be
and download and install the package if it exists. Any dependencies will be
downloaded and installed first.

This is possible because we have the dependency information in the
@@ -240,7 +240,7 @@ autotools and some other tools installed.
# pkg install autoconf automake libtool pkgconf

The next thing to do is to get the pkg sources installed on your machine.
You can grab a development snapshot of pkg from the [pkg Github repository][1]
You can grab a development snapshot of pkg from the [pkg GitHub repository][1]

To get the latest version of pkg from the Git repo, just clone it:

@@ -270,7 +270,7 @@ installed.

Note: if you're running anything other than FreeBSD or DragonFly, you
will need to do some porting work. The pkg(8) codebase should be
reasoably portable onto anything with a c99 compiler, posix compliant
reasonably portable onto anything with a c99 compiler, POSIX compliant
system and capable of running Gnu autotools. However, various places
in the pkg(8) code make assumptions about OS specific behaviour. If
you do try anything like this, we'd be very interested to hear how you
@@ -279,7 +279,7 @@ get on.
<a name="pkg2ng"></a>
### Converting an old-style pkg database

If you're on a 9.x system or earler and did not have a release version
If you're on a 9.x system or earlier and did not have a release version
of pkg(8) installed previously, you will need to run the pkg2ng
script. This is only necessary when converting your system from the
old pkg_tools style packages.
@@ -394,11 +394,11 @@ To disable the default FreeBSD.conf, create a file
FreeBSD: { enabled: no }
```

To check quickly what repositories you have onfigured, run `pkg -vv`.
To check quickly what repositories you have configured, run `pkg -vv`.

See *pkg.conf(5)* for details of the format of `pkg.conf` and the
per-repository `repo.conf` files. See *pkg-repository(5)* for more
details about package repositories and how to work ith them.
details about package repositories and how to work with them.

Note that the old style of setting _PACKAGESITE_ in pkg.conf is
no-longer supported. Setting _PACKAGESITE_ in the environment has
@@ -531,7 +531,7 @@ your repository :)
<a name="resources"></a>
### Additional resources

* The Git repository of [pkg is hosted on Github][1]
* The Git repository of [pkg is hosted on GitHub][1]

* The [pkg Wiki page][2]



+ 2
- 2
docs/GOALS Ver ficheiro

@@ -55,7 +55,7 @@ Table of Contents:
The first repo contains all information about a package, except for
the files (which will be in the second one) + it will compute and
add a sha256 sum for each package.
- The database will be a sqlite file compressed with the xz format.
- The database will be a SQLite file compressed with the xz format.
- The database will be signed so we can trust the sha256 of the
packages, and if a package has the expected hash, it is considered
trusted.
@@ -92,7 +92,7 @@ Table of Contents:

- update:

- Will fetch the remote repository sqlite database file.
- Will fetch the remote repository SQLite database file.

- lint:



+ 2
- 2
docs/pkg-create.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-CREATE 8
.Os
.\" ---------------------------------------------------------------------------
@@ -184,7 +184,7 @@ file.
This is exactly the same format as
.Pa +MANIFEST
mentioned above, but any file name can be used, and no
other file will be used to read package metada from.
other file will be used to read package metadata from.
If specified, only a single package will be created.
This option is incompatible with the
.Fl m, a, g


+ 2
- 2
docs/pkg-delete.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd May 26, 2014
.Dd November 18, 2014
.Dt PKG-DELETE 8
.Os
.Sh NAME
@@ -82,7 +82,7 @@ Make the standard or regular expression
matching against
.Ar pkg-name
case insensitive.
This is the defalt, unless modified by setting
This is the default, unless modified by setting
.Ev CASE_SENSITIVE_MATCH
to true in
.Pa pkg.conf .


+ 7
- 7
docs/pkg-query.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-QUERY 8
.Os
.Sh NAME
@@ -113,11 +113,11 @@ Home page of the matched package
.It Cm \&%l
License logic of the matched package - nothing for single, & for AND, and | for OR
.It Cm \&%s Ns Op bh
Flat size of the matched package, where
The flat size of the matched package, where
.Cm b
is in bytes, and
.Cm h
is in human readable format
is in human readable format.
.It Cm \&%a
Returns 1 if the matched package is an orphan package and can be pkg-autoremove(1)'d, 0 otherwise
.It Cm \&%q
@@ -129,10 +129,10 @@ message contained in the matched package
.It Cm \&%t
Timestamp that the package was installed
.It Cm \&%R
Name of the repository from which the package was installed if
The name of the repository from which the package was installed if
available, or
.Dq unknown-repository
otherwise
otherwise.
.It Cm \&%? Ns Op drCFODLUGBbA
Returns 0 if the list is empty and 1 if the list has information to display
.Bl -tag -width indent
@@ -231,7 +231,7 @@ for option default value and
.Cm D
for option description.
Option default values and descriptions are optional metadata and may
beblank for certain packages.
be blank for certain packages.
.It Cm \&%L
Expands to the list of license(s) for the matched package.
.It Cm \&%U
@@ -292,7 +292,7 @@ Message of the package (type string)
.It Cm \&%t
Timestamp that the package was installed (type integer)
.It Cm \&%i
Additionnal information about the package (type string)
Additional information about the package (type string)
.It Cm \&%# Ns Op drCFODLUGBbA
Number of elements in the list of information (type integer).
See


+ 2
- 2
docs/pkg-repo.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-REPO 8
.Os
.Sh NAME
@@ -125,7 +125,7 @@ The following options are supported by
.It Fl q , Cm --quiet
Force quiet output.
.It Fl L , Cm --legacy
Create repostory compatible with pkg 1.2.
Create repository compatible with pkg 1.2.
.It Fl m Ar meta-file , Cm --meta-file Ar meta-file
Use the specified file as repository meta file instead of the default settings.
.It Fl l , Cm --list-files


+ 3
- 3
docs/pkg-repository.5 Ver ficheiro

@@ -15,13 +15,13 @@
.\" @(#)pkg-repository.5
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-REPOSITORY 5
.Os
.Sh NAME
.Nm "package repository"
.Nd format and operation of package repositories used by
.Xr pkg 8
.Xr pkg 8 .
.Sh DESCRIPTION
.Nm "Package repositories"
used by the
@@ -134,7 +134,7 @@ or later.
.It Pa $REPOSITORY_ROOT/repo.txz
(Deprecated).
Contains the package manifest data as above, but pre-loaded into
an Sqlite database.
an SQLite database.
This is supplied for backwards compatibility with
.Nm pkg-1.0 .
.It Pa $REPOSITORY_ROOT/filesite.txz


+ 6
- 6
docs/pkg-search.8 Ver ficheiro

@@ -1,5 +1,5 @@
.\"
.\" Freebsd pkg - a next generation package for the installation and
.\" FreeBSD pkg - a next generation package for the installation and
.\" maintenance of non-core utilities.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-SEARCH 8
.Os
.Sh NAME
@@ -118,7 +118,7 @@ Equivalent to
Treat
.Ar pattern
as a shell globbing expression.
The glob pattern must match the entire field being seached.
The glob pattern must match the entire field being searched.
.It Fl i , Cm --case-insensitive
Make the exact
.Fl ( e )
@@ -231,7 +231,7 @@ The one line comment field describing the port, derived from the
variable in the port's
.Fa Makefile .
When chosen as a label option, the output format will additionally
include the packge name, equivalent to
include the package name, equivalent to
.Fl "L pkg-name"
.Fl "Q comment" .
When chosen as a search option, only the
@@ -350,7 +350,7 @@ and
.Sy descr
fields, in that order.
.It Sy licenses
Displays a list of all the licenses the package is relesed under on a
Displays a list of all the licenses the package is released under on a
single line.
Where more than one license applies, indicate if the terms of all
licenses should apply
@@ -380,7 +380,7 @@ need to be downloaded from the repository.
Display the installation prefix for the package, usually
.Fa /usr/local .
.It Sy repository
Displays the repository name and the corresponding base Url for the
Displays the repository name and the corresponding base URL for the
repository.
For a default repository defined in
.Pa pkg.conf .


+ 3
- 3
docs/pkg-set.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd May 26, 2014
.Dd November 18, 2014
.Dt PKG-SET 8
.Os
.Sh NAME
@@ -105,7 +105,7 @@ See
.Xr pkg.conf 5 .
.Sh EXAMPLES
Upgrade perl from 5.12 to 5.14.
This involes moving the origin from
This involves moving the origin from
.Sy lang/perl5.12
to
.Sy lang/perl5.14 :
@@ -113,7 +113,7 @@ to
.Dl % pkg install -Rf lang/perl5.14
.Pp
Upgrade ruby from 1.8 to 1.9.
This involes moving the origin from
This involves moving the origin from
.Sy lang/ruby18
to
.Sy lang/ruby19 :


+ 2
- 2
docs/pkg-shell.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd March 11, 2013
.Dd November 18, 2014
.Dt PKG-SHELL 8
.Os
.Sh NAME
@@ -36,7 +36,7 @@ Use
.Xr pkg-search 8
and
.Xr pkg-set 8
instead for querying and modiying the database.
instead for querying and modifying the database.
These commands are expected to have a stable API, unlike the database schema.
.Sh ENVIRONMENT
The following environment variables affect the execution of


+ 2
- 2
docs/pkg-shlib.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-SHLIB 8
.Os
.Sh NAME
@@ -47,7 +47,7 @@ The following mutually exclusive options are supported by
.Nm :
.Bl -tag -width provides
.It Fl P , Cm --provides
Show only the installed packages which provide
Show only the installed packages which provide the named
.Ar library .
.It Fl R , Cm --requires
Show only the installed packages which require


+ 2
- 3
docs/pkg-upgrade.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG-UPGRADE 8
.Os
.Sh NAME
@@ -48,8 +48,7 @@ is that
.Nm
tries to upgrade dependencies of packages matched as well while
.Xr pkg-install 8
is more conservative during dependencies upgrade.
Moreover,
is more conservative during dependencies upgrade. Moreover,
.Nm
cannot install new packages, so a caller should ensure that patterns specified
as arguments have installed candidates for matching.


+ 6
- 7
docs/pkg.8 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.8
.\" $FreeBSD$
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG 8
.Os
.\" ---------------------------------------------------------------------------
@@ -83,14 +83,13 @@ will override any other command line arguments.
.It Fl o Ao option=value Ac , Cm --option Ao option=value Ac
Set configuration option for
.Nm
from the command line.
Options that are set from the environment are redefined.
It is permitted to specify this option multiple times.
from the command line. Options that are set from the environment are
redefined. It is permitted to specify this option multiple times.
.It Fl N
Activation status check mode.
Prevent
.Nm
from automatically creating or initializing the sqlite database in
from automatically creating or initializing the SQLite database in
.Pa /var/db/pkg/local.sqlite
if it does not already exist.
.Pp
@@ -259,14 +258,14 @@ repositories.
.It Ic set
Modify information in the installed database.
.It Ic shell
Open a sqlite shell to the local or remote database.
Open a SQLite shell to the local or remote database.
Extreme care should be taken when using this command.
.It Ic shlib
Displays which packages link to a specific shared library.
.It Ic stats
Display package database statistics.
.It Ic unlock
Permit modification or deletion of a package.
Unlocks packages, allowing them to be modified or deleted.
.It Ic update
Update the available remote repositories as listed in
.Xr pkg.conf 5 .


+ 10
- 12
docs/pkg.conf.5 Ver ficheiro

@@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd November 09, 2014
.Dd November 18, 2014
.Dt PKG.CONF 5
.Os
.Sh NAME
@@ -108,7 +108,7 @@ as an aide to port maintainers, including indicating when the port
might be marked as architecture independent.
Default: NO.
.It Cm EVENT_PIPE: string
Send all event messages to the specified fifo or Unix socket.
Send all event messages to the specified FIFO or Unix socket.
Events messages should be formatted as JSON.
Default: not set.
.It Cm FETCH_RETRY: integer
@@ -158,12 +158,11 @@ Hostname or IPv4 or IPv6 address of name server to use for DNS
resolution, overriding the system defaults in
.Pa /etc/resolv.conf .
When given as a hostname, will be converted to a list of IPv4 or IPv6
addresses by the default mechanisms configured on the system.
See
addresses by the default mechanisms configured on the system. See
.Xr getaddrinfo 3 .
.It Cm PERMISSIVE: boolean
Ignore conflicts while registering a package.
Note that the conflicting files will not be recorded as owned by the new package.
Ignore conflicts while registering a package. Note that the
conflicting files will not be recorded as owned by the new package.
Default: NO.
.It Cm PKG_CACHEDIR: string
Specifies the cache directory for packages.
@@ -246,7 +245,7 @@ Default: YES.
Experimental: tells pkg to use and external SAT solver.
Default: not set.
.It Cm SQLITE_PROFILE: boolean
Profile sqlite queries.
Profile SQLite queries.
Default: NO.
.It Cm SSH_RESTRICT_DIR: string
Directory which the ssh subsystem will be restricted to.
@@ -282,8 +281,7 @@ vulnerability database from.
Default:
.Pa http://www.vuxml.org/freebsd/vuln.xml.bz2 .
.It Cm WORKERS_COUNT: integer
How many workers are used for pkg-repo.
If set to 0,
How many workers are used for pkg-repo. If set to 0,
.Va hw.ncpu
is used.
Default: 0.
@@ -386,7 +384,7 @@ is
then the
.Sy PUBKEY
option will be used for signature verification.
This option is for use with the builtin signing support.
This option is for use with the built-in signing support.
When
.Sy SIGNATURE_TYPE
is
@@ -430,7 +428,7 @@ Rather than editing that file directly, create
.Pa /usr/local/etc/pkg/repos/FreeBSD.conf
with this content:
.Bd -literal -offset indent
FreeBSD: { enabled: no }
FreeBSD: { enabled: NO }
.Ed
.Pp
Repositories are prioritized in the order they are found on the
@@ -500,7 +498,7 @@ example: {
EOF
# cat > /usr/local/etc/pkg/repos/FreeBSD.conf <<EOF
FreeBSD: {
enabled: no
enabled: NO
}
EOF
# env PACKAGESITE='http://pkgrepo.example.com/${ABI}' \


+ 2
- 2
docs/pkg_printf.3 Ver ficheiro

@@ -30,7 +30,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG_PRINTF 3
.Os
.Sh NAME
@@ -845,7 +845,7 @@ or
.Sq AND ,
which shows whether the package is distributed under the terms of a
single license, or when there are several applicable licenses, whether
these should be treated as alternatives or applied in agregate.
these should be treated as alternatives or applied in aggregate.
There are three different output styles: plain; or alternate forms 1
and 2 specified using format modifiers.
.Bl -column "SINGLE" "Plain (%l)" "Alt 1 (%?l)" "Alt 2 (%#l)" -offset indent


+ 6
- 7
docs/pkg_repos.3 Ver ficheiro

@@ -1,4 +1,4 @@
.Dd October 30, 2014
.Dd November 18, 2014
.Dt PKG_REPOS 3
.Os
.Sh NAME
@@ -43,7 +43,7 @@
.Sh DESCRIPTION
.Fn pkg_repos
Takes the address of a pointer to the repository.
The pointer should be initialized to NULL before being passed to the
The pointer should be initialised to NULL before being passed to the
function, on each iteration the r will point to the new repository.
Returns EPKG_FATAL if an error occurred, otherwise return EPKG_OK until
the last repository is found in that case EPKG_END is returned.
@@ -77,8 +77,7 @@ If the repository is not signed by a public key, NULL will be returned.
.Pp
.Fn pkg_repo_fingerprints
takes a pointer to a repository as argument and returns the path to
the fingerprints.
If the repository is not signed using the
the fingerprints. If the repository is not signed using the
.Qq FINGERPRINT
method, NULL will be returned.
.Pp
@@ -116,10 +115,10 @@ The repository does not have any mirror.
.Pp
.Fn pkg_repo_find_ident
Take an internal indentification string as argument and return a pointer to
a reprository. If no repository matches, NULL is returned.
a repository. If no repository matches, NULL is returned.
.Pp
.Fn pkg_repo_find_name
Take a repository
.Qq name
as argument and return a pointer to a reprository.
If no repository matches, NULL is returned.
as argument and return a pointer to a repository. If no repository matches,
NULL is returned.

Carregando…
Cancelar
Guardar