aboutsummaryrefslogtreecommitdiffstats
path: root/bosun.1
diff options
context:
space:
mode:
Diffstat (limited to 'bosun.1')
-rw-r--r--bosun.173
1 files changed, 73 insertions, 0 deletions
diff --git a/bosun.1 b/bosun.1
new file mode 100644
index 0000000..cfe0a12
--- /dev/null
+++ b/bosun.1
@@ -0,0 +1,73 @@
+.Dd June 19, 2019
+.Dt BOSUN 1
+.Os
+.Sh NAME
+.Nm bosun
+.Nd manage portage roles with stow
+.Sh SYNOPSIS
+.Nm
+.Op Ar command
+.Sh DESCRIPTION
+.Nm
+is a program to add, remove, and list portage roles.
+.Pp
+A
+.Dq role
+is a directory comprised of a set of portage configuration files
+pertaining to a specific service, usage, et cetera.
+Roles are placed into
+.Em /etc/portage/stow .
+.Pp
+.Nm
+uses
+.Xr stow 1
+to build a full set of portage configuration files in
+.Em /etc/portage .
+It does so by creating symlinks in
+.Em /etc/portage
+that point back to the actual files in the role directories.
+.Pp
+The commands are as follows:
+.Bl -tag -width Ds
+.It Sy add Em role
+Activates the given role on the system.
+.It Sy flush
+Deactivates all actives roles on the system.
+.It Sy list [ Em type ]
+Lists roles of the given type.
+If no type is given, list roles of the
+.Dq active
+type.
+The types are as follows:
+.Bl -tag -width Ds
+.It Sy active
+Lists roles that are active on the system.
+.It Sy all
+Lists all roles.
+.It Sy available
+Lists roles that not active on the system.
+.El
+.It Sy rebuild
+Deactivates all active roles and then activates them again.
+This is used to incorporate files that have been added to an already
+active role.
+.It Sy remove Em role
+Deactivates the given role on the system.
+.El
+.Pp
+If no command is given,
+.Nm
+will list active roles.
+.Sh FILES
+.Bl -tag -width Ds
+.It Em /etc/portage/stow
+The base directory containing all portage roles.
+.El
+.Sh SEE ALSO
+.Xr stow 1 ,
+.Xr portage 5
+.Sh AUTHORS
+.An -nosplit
+.Nm
+was written by
+.An Wolfgang Müller Aq Mt vehk@vehk.de