From 5c3c192d16e3574484c885f2025282bb586baad4 Mon Sep 17 00:00:00 2001 From: Juan RP Date: Fri, 18 Apr 2014 09:45:25 +0200 Subject: [PATCH] xbps-uchroot(8): now with a manual page. --- bin/xbps-uchroot/Makefile | 1 - bin/xbps-uchroot/xbps-uchroot.8 | 67 +++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 bin/xbps-uchroot/xbps-uchroot.8 diff --git a/bin/xbps-uchroot/Makefile b/bin/xbps-uchroot/Makefile index 55c6ec5d..fff5a308 100644 --- a/bin/xbps-uchroot/Makefile +++ b/bin/xbps-uchroot/Makefile @@ -2,6 +2,5 @@ TOPDIR = ../.. -include $(TOPDIR)/config.mk BIN = xbps-uchroot -MAN = include $(TOPDIR)/mk/prog.mk diff --git a/bin/xbps-uchroot/xbps-uchroot.8 b/bin/xbps-uchroot/xbps-uchroot.8 new file mode 100644 index 00000000..8d745288 --- /dev/null +++ b/bin/xbps-uchroot/xbps-uchroot.8 @@ -0,0 +1,67 @@ +.Dd April 18, 2014 +.Os Void Linux +.Dt xbps-uchroot 8 +.Sh NAME +.Nm xbps-uchroot +.Nd XBPS utility to chroot and bind mount with linux namespaces +.Sh SYNOPSYS +.Nm xbps-uchroot +.Op OPTIONS +.Ar CHROOTDIR +.Ar COMMAND +.Op ARGS +.Sh DESCRIPTION +The +.Nm +utility allows users to chroot and bind mount required pseudo-filesystems +(/dev, /proc and /sys) in the target +.Ar CHROOTDIR +to execute +.Ar COMMAND . +The +.Nm +utility uses by default Linux namespaces to isolate IPC, PIDs and mounts to +the calling process. If running in a OpenVZ container, these namespace features +are simply disabled. +.Sh OPTIONS +.Bl -tag -width -x +.It Fl D Ar dir +Specifies a full path to a directory that will be bind mounted at +.Ar CHROOTDIR/xbps-packages . +.It Fl H Ar dir +Specifies a full path to a directory that will be bind mounted at +.Ar CHROOTDIR/host . +.It Fl S Ar dir +Specifies a full path to a directory to allow shm functionality to be used +in the target +.Ar CHROOTDIR/dir . +If your system uses +.Sy /dev/shm +use it, otherwise use +.Sy /run/shm . +.Sh SECURITY +The +.Nm +executable must be setgid to function properly and shall only be executable by a specific +group to avoid security issues (4750). +.Sh NOTES +The +.Nm +utility uses Linux specific features (namespaces) and it's not meant to be portable to +other Operating Systems. +.Sh SEE ALSO +.Xr xbps-checkvers 8 , +.Xr xbps-create 8 , +.Xr xbps-dgraph 8 , +.Xr xbps-install 8 , +.Xr xbps-pkgdb 8 , +.Xr xbps-query 8 , +.Xr xbps-reconfigure 8 , +.Xr xbps-rindex 8 +.Sh AUTHORS +.An Juan Romero Pardines +.Sh BUGS +Probably, but I try to make this not happen. Use it under your own +responsability and enjoy your life. +.Pp +Report bugs in https://github.com/voidlinux/xbps/issues