lblinux
/
lbpkg
1
1
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request 'Fix spelling and stylistic mistakes' (#1) from lemonsh/lbpkg:lemonsh-spelling-fix into master 

Reviewed-on: #1
stable
Polarian 2022-12-27 17:21:50 +00:00
parent dcb47aae1f 66d58ac984
commit f030710609
1 changed files with 19 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
spec/spec.md
View File

@ -1,21 +1,21 @@
# Specification for lbpkg's
This file contains the full specification for lbpkgs
# Specification for lbpkgs
This file contains the full specification for lbpkgs.
## File extension
lbpkgs use the file extension `.lbpkg`, all files in the package
are contained within a`tar`, compressed using `xz`.
lbpkgs use the file extension `.lbpkg`. All files in the package
are contained within a `tar`, compressed using `xz`.
We have chosen to use `xz` over the over pupular compression algorithms
We have chosen to use `xz` over the other popular compression algorithms
as we currently need packages to be small to save disk space and
bandwidth, which for a small linux distribution is something which is
very valuable. We may support lighter compressed packages later on which
are fast at decompressing allowing for high speed installation, provided
bandwidth, which for a small linux distribution is very valuable.
We may support lighter compressed packages later on, that
are fast at decompressing, allowing for high speed installation, provided
the bandwidth is there to support it.
## Package layout
Unlike other package formats, lbpkg's do not use directories to define
the path to install packages to, instead there is a `LBMANIFEST` in
the root of the package, which contains the filename and then the path
Unlike other package formats, lbpkgs do not use directories to define
the path to install packages to, instead there is a `LBMANIFEST` file in
the root of the package, which contains the filename and the path
for the file to be installed to.
There should also be a `PKGINFO` file within the package, which outlines
@ -32,8 +32,7 @@ to be valid
### Manifest
The manifest file should be named `LBMANIFEST` (case specific), each
line of the file declares the name the file or directory to install, the
name and install path should be separated with space (`U+0020`), see
example below:
name and install path should be separated with space (`U+0020`), for example:
`bash /bin/bash`
@ -41,12 +40,12 @@ This follows the format:
`<file/directory name> <full install path>`
Each line of the manifest, corresponds to its own file/directory to be
Each line of the manifest corresponds to its own file/directory to be
installed.
#### Setting file permissions
You can set the file permissions of a file within the manifest file by
appending the permission after the install path, example below:
You can set the Unix permissions of a file within the manifest file by
appending the permissions after the install path, for example:
`bash /bin/bash 775`
@ -54,20 +53,19 @@ This follows the format:
`<file/directory name> <full install path> <permission>`
If a permission is not defined, the permission of the file within the
package is used.
If permissions are not defined, the permissions of the file within the
package are used.
#### Setting ownership
You can set the ownership of a file or directory within the manifest
file by appending the ownership string (`<user>:<group>`) after the
permission, example below:
permission, for example:
`bash /bin/bash 775 root:root`
This follows the format:
`<file/directory name> <full install path> <permission> <ownership
string>`
`<file/directory name> <full install path> <permission> <ownership string>`
If the ownership is not defined, the ownership of the file within the
package is used.