Skip to content

Commit

Permalink
Base: Add manpage for pkg
Browse files Browse the repository at this point in the history
  • Loading branch information
cubiclove authored and awesomekling committed Sep 12, 2023
1 parent 6393944 commit 842b2a0
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions Base/usr/share/man/man1/pkg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Name

pkg - Package Manager

## Synopsis

```**sh
$ pkg [-l] [-d] [-u] [-v] [-q package]
```

## Description

This program can list installed packages and query for [available packages](https://github.com/SerenityOS/serenity/blob/master/Ports/AvailablePorts.md). The [Ports for SerenityOS website](https://ports.serenityos.net) has more detailed information about available packages.

It does not currently support installing and uninstalling packages. To install third-party software use the [Ports system](https://github.com/SerenityOS/serenity/blob/master/Ports/README.md).

## Options

* `-l`, `--list-manual-ports`: Show all manually-installed ports
* `-d`, `--list-dependency-ports`: Show all dependencies' ports
* `-u`, `--update-ports-database`: Sync/Update ports database
* `-v`, `--verbose`: Verbose output
* `-q`, `--query-package`: Query the ports database for package name

## Arguments

* `package`: The name of the package you want to query

## Example

```sh
# Query the ports database for the serenity-theming package
$ pkg -q serenity-theming
```

0 comments on commit 842b2a0

Please sign in to comment.