Skip to content
This repository has been archived by the owner on Dec 20, 2022. It is now read-only.

Latest commit

 

History

History
65 lines (51 loc) · 2.75 KB

nyaa_run.8.md

File metadata and controls

65 lines (51 loc) · 2.75 KB
Raw

% nyaa_run(8)

NAME

nyaa runfile - main package format of nyaa

DESCRIPTION

nyaa runfiles are the main package format of nyaa. It is a basic shell script with some variables so nyaa can build the package.

RUNFILE STRUCTURE

We highly recommend looking at nyaa's build_package() function as there might be breaking changes

Runfiles are just named "run" inside the package directory. It is written in POSIX sh and doesn't support any other languages. In addition to a runfile you also need a deps file which you can add by just making a file named "deps" in the package repository and putting deps on each line.

An example runfile structure;

NAME="test"
VERSION="0.0.1"
RELEASE="1"
SOURCES="https://test.file/source/testfile.tar.gz"
SHA256SUM="e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855  testfile.tar.gz"
DESCRIPTION="Test package"

build() {
    tar -xvf testfile.tar.gz
    echo "Insert additional installation instructions here"
}

Now lets break it down.

VARIABLES

  • NAME: Name of your package. Will show this name on the info command.
  • VERSION: Version of your package. It will be on the info command and updating it will result in nyaa upgrading the package.
  • RELEASE: Release of your package. It will also be on the info command and updating it will result in nyaa upgrading the package.
  • SOURCES: Source URL's of your package. Can be seperated by ';' like test.url;testurl2.
  • SHA256SUM: sha256sum output of the sources. Should align with sources. Can also be seperated by ';'.
  • DESCRIPTION: Description of the package. It will be on the info command.

FUNCTIONS

  • build: The main function.

OPTIONAL FUNCTIONS AND VARIABLES

  • EPOCH: Only use this when the versioning logic fail for the package.
  • prepare(): Files downloaded from SOURCES are extracted by default. Use prepare() to prevent this and have custom prepare procedure.
  • post_install(): Does what it says. Runs commands after installation.
  • post_uninstall(): Does what it says. Runs commands after uninstallation.
  • custom_uninstall(): Allows you to have a custom uninstall procedure and bypasses the package removal procedure. Only use this when needed.

AUTHOR

Written by Kreato.

COPYRIGHT

nyaa is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

nyaa is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with nyaa. If not, see https://www.gnu.org/licenses/.