Skip to content

Commit

Permalink
Update manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
isbm committed Aug 31, 2023
1 parent ba080a3 commit cfeaf8b
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 54 deletions.
67 changes: 37 additions & 30 deletions doc/limopack.8
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,7 @@
(Helper)
.SH SYNOPSIS
.PP
Usage of the limopack as follows:
.IP
.nf
\f[C]
USAGE:
limopack [OPTIONS]

OPTIONS:
-d, --debug Set to debug mode
-e, --tree Display module dependency tree
-h, --help Print help information
-u, --use <use> Specify comma-separated list of kernel modules to be used
-v, --version Get current version
\f[R]
.fi
Usage of the limopack as follows: \f[C]limopack [OPTIONS]\f[R]
.SH DESCRIPTION
.PP
The \f[B]limopack\f[R] is a Linux Kernel modules packaging helper, which
Expand Down Expand Up @@ -58,30 +44,51 @@ When a new update comes, modules package is then brought back for
update.
.SS OPTIONS
.TP
-d, \[en]debug
Set to debug mode
-u, \[en]use
Specify comma-separated list of kernel modules to be processed.
For example
you can specify \f[B]\[en]use=module1,module2,module3\f[R] etc.
.TP
-s, \[en]static
Use specified modules as static (i.e.\ stays permanently)
.TP
-e, \[en]tree
Display module dependency tree
Display module dependency tree.
.TP
-h, \[en]help
Print help information
-l, \[en]list
Display in a sorted flat list format all modules that will
be used.
This includes all dependencies and already marked
and existing modules.
.TP
-p, \[en]pkname
Specify a package name, which needs to be un-registered
from the package manager database in order to be visible to the system
as
non-existing, so the system can bring it again for an update or
installation.
.TP
-i, \[en]install
Add to the list of used modules, those are specified by \f[C]--use\f[R]
option.
Mark specified modules as needed for the system.
.TP
-s, \[en]shrink
Remove unused kernel modules (vacuum) from the media.
-r, \[en]remove
Remove specified modules as no longer needed for the system,
so they can be purged from the disk.
This operation only marks
the modules to be removed, but does not actually removes them.
.TP
-u, \[en]use
Specify comma-separated list of kernel module to be used.
Kernel module can have a partial path to it (without
\f[C]/lib/modules/<version>/kernel\f[R] as a prefix), and also can have
only names or with \f[C].ko\f[R] extension.
-a, \[en]apply
Apply the changes, vacuuming all unneded/unregisterd (non-marked)
kernel modules, those are still exist on a disk, but always unused.
\f[I]NOTE: this option can be only used alone, as it commits the
changes\f[R]
.TP
-d, \[en]debug
Set debug mode for more verbose output.
-v, \[en]version
Get current version
Get current version.
-h, \[en]help
Print help
.SH FILES
.TP
\f[I]/usr/bin/limopack\f[R]
Expand Down
59 changes: 35 additions & 24 deletions doc/limopack.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,7 @@ NAME
SYNOPSIS
========

Usage of the limopack as follows:

USAGE:
limopack [OPTIONS]

OPTIONS:
-d, --debug Set to debug mode
-e, --tree Display module dependency tree
-h, --help Print help information
-u, --use <use> Specify comma-separated list of kernel modules to be used
-v, --version Get current version
Usage of the limopack as follows: `limopack [OPTIONS]`

DESCRIPTION
===========
Expand Down Expand Up @@ -54,35 +44,56 @@ When a new update comes, modules package is then brought back for update.
OPTIONS
-------

-d, --debug
-u, --use <use>

: Set to debug mode
: Specify comma-separated list of kernel modules to be processed. For example
: you can specify **--use=module1,module2,module3** etc.

-s, --static

: Use specified modules as static (i.e. stays permanently)

-e, --tree

: Display module dependency tree
: Display module dependency tree.

-h, --help
-l, --list

: Print help information
: Display in a sorted flat list format all modules that will
: be used. This includes all dependencies and already marked
: and existing modules.

-p, --pkname <pkname>

: Specify a package name, which needs to be un-registered
: from the package manager database in order to be visible to the system as
: non-existing, so the system can bring it again for an update or installation.

-i, --install

: Add to the list of used modules, those are specified by `--use` option.
: Mark specified modules as needed for the system.

-s, --shrink
-r, --remove

: Remove unused kernel modules (vacuum) from the media.
: Remove specified modules as no longer needed for the system,
: so they can be purged from the disk. This operation only marks
: the modules to be removed, but does not actually removes them.

-u, --use <use>
-a, --apply

: Specify comma-separated list of kernel module to be used. Kernel
module can have a partial path to it (without `/lib/modules/<version>/kernel`
as a prefix), and also can have only names or with `.ko` extension.
: Apply the changes, vacuuming all unneded/unregisterd (non-marked)
: kernel modules, those are still exist on a disk, but always unused.
: *NOTE: this option can be only used alone, as it commits the changes*

-d, --debug

: Set debug mode for more verbose output.
-v, --version

: Get current version
: Get current version.
-h, --help

: Print help

FILES
=====
Expand Down

0 comments on commit cfeaf8b

Please sign in to comment.