Переглянути джерело

use "openpkg lsync" consistently in lsync manual page

Ralf S. Engelschall 21 роки тому
батько
коміт
7f121484cf
2 змінених файлів з 48 додано та 48 видалено
  1. 24 24
      openpkg/lsync.8
  2. 24 24
      openpkg/lsync.pod

+ 24 - 24
openpkg/lsync.8

@@ -131,10 +131,10 @@
 .IX Title "LSYNC 8"
 .TH LSYNC 8 "OpenPKG" "LSYNC(8)" "OpenPKG"
 .SH "NAME"
-\&\fBlsync\fR \- Access Layer Synchronization Tool
+\&\fBopenpkg lsync\fR \- Access Layer Synchronization Tool
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fBlsync\fR
+\&\fBopenpkg lsync\fR
 [\fB\-\-version\fR|\fB\-v\fR]
 [\fB\-\-help\fR|\fB\-h\fR]
 [\fB\-\-init\fR|\fB\-i\fR]
@@ -181,7 +181,7 @@ This activates the Unix manual page
 \&\fIroot\fR\fB/\fR\fIpkgdir\fR\fB/\fRbar\fB/man/man\fR\fIN\fR\fB/\fRfoo as
 \&\fIroot\fR\fB/man/man\fR\fIN\fR\fB/\fRfoo. It can be found by the \fIman\fR\|(1) tool
 by placing \fIroot\fR\fB/man\fR into the environment variable \f(CW\*(C`MANPATH\*(C'\fR
-(\fBMANPATH="..:\fR\fIroot\fR\fB/man:.."\fR). Keep in mind that \fIlsync\fR\|(1)
+(\fBMANPATH="..:\fR\fIroot\fR\fB/man:.."\fR). Keep in mind that \fBopenpkg lsync\fR
 activates any files found in the \fBman/man\f(BIN\fB\fR sub-directory of the
 package, but the \fIman\fR\|(1) tool usually requires the filename scheme
 foo\fB.\fR\fIN\fR before it can find the file.
@@ -191,7 +191,7 @@ This activates the \s-1GNU\s0 info page \fIroot\fR\fB/\fR\fIpkgdir\fR\fB/\fRbar\
 as \fIroot\fR\fB/info/\fRfoo. It can be found by the \fIinfo\fR\|(1) and \fIpinfo\fR\|(1)
 tools by placing \fIroot\fR\fB/info\fR into the environment variable
 \&\f(CW\*(C`INFOPATH\*(C'\fR (\fBINFOPATH="..:\fR\fIroot\fR\fB/info:.."\fR). Keep in mind that
-\&\fIlsync\fR\|(1) activates any files found in the \fBinfo/\fR sub-directory of the
+\&\fBopenpkg lsync\fR activates any files found in the \fBinfo/\fR sub-directory of the
 package, but the \fIinfo\fR\|(1) and \fIpinfo\fR\|(1) tools usually require the filename
 scheme foo\fB.info\fR before it can find the file.
 .IP "\fIroot\fR\fB/include/\fRfoo \-> \fB../\fR\fIpkgdir\fR\fB/\fRbar\fB/include/\fRfoo" 4
@@ -199,7 +199,7 @@ scheme foo\fB.info\fR before it can find the file.
 This activates the C header \fIroot\fR\fB/\fR\fIpkgdir\fR\fB/\fRbar\fB/include\fR/foo
 as \fIroot\fR\fB/include/\fRfoo. It can be found by the C/\*(C+ compilers
 by adding \fIroot\fR\fB/include\fR to their include search path (\fBcc ..
-\&\-I\fR\fIroot\fR\fB/include\fR \fB...\fR). Keep in mind that \fIlsync\fR\|(1) activates any
+\&\-I\fR\fIroot\fR\fB/include\fR \fB...\fR). Keep in mind that \fBopenpkg lsync\fR activates any
 files found in the \fBinclude/\fR sub-directory of the package, but the
 C/\*(C+ compiler usually by convention use the filename scheme foo\fB.h\fR.
 .IP "\fIroot\fR\fB/lib/\fRfoo \-> \fB../\fR\fIpkgdir\fR\fB/\fRbar\fB/lib/\fRfoo" 4
@@ -210,48 +210,48 @@ the linker they use) by adding \fIroot\fR\fB/lib\fR to their library search
 path (\fBcc .. \-L\fR\fIroot\fR\fB/lib\fR \fB...\fR). It can be found by the Unix
 Dynamic Loader by adding \fIroot\fR\fB/lib\fR to the environment variable
 \&\f(CW\*(C`LD_LIBRARY_PATH\*(C'\fR (\fBLD_LIBRARY_PATH="..:\fR\fIroot\fR\fB/lib:.."\fR).
-Keep in mind that \fIlsync\fR\|(1) activates any files found in the \fBlib/\fR
+Keep in mind that \fBopenpkg lsync\fR activates any files found in the \fBlib/\fR
 sub-directory of the package, but the C/\*(C+ compiler usually require the
 filename scheme \fBlib\fRfoo\fB.a\fR and the Unix Dynamic Loader the filename
 scheme \fBlib\fRfoo\fB.so\fR before they actually can use the file.
 .PP
 It is obvious that more sub-directories in a package installation
 might exist \*(-- for instance \fBshare/\fR, \fBvar/\fR, \fBlibexec/\fR, etc. But
-\&\fIlsync\fR\|(1) intentionally does not link files in those directories into
+\&\fBopenpkg lsync\fR intentionally does not link files in those directories into
 corresponding directories of the access layer, because those files do
 not require that they are located in a global area in order to be used.
-So \fIlsync\fR\|(1) only creates the access layer for files where a common area
+So \fBopenpkg lsync\fR only creates the access layer for files where a common area
 is required for (easy) use.
 .SH "SPECIAL FEATURES"
 .IX Header "SPECIAL FEATURES"
-There are two special features supported by \fIlsync\fR\|(1):
+There are two special features supported by \fBopenpkg lsync\fR:
 .IP "\fBRun-Command Files\fR" 4
 .IX Item "Run-Command Files"
-\&\fIlsync\fR\|(1) on startup implicitly reads command line options from
+\&\fBopenpkg lsync\fR on startup implicitly reads command line options from
 \&\f(CW\*(C`.lsyncrc\*(C'\fR files. They are searched in all parent directories and in
 the callers home directory. Their contents is prepended to the list of
 given command line options.
 .IP "\fBMultiple Package Versions\fR" 4
 .IX Item "Multiple Package Versions"
-\&\fIlsync\fR\|(1) skips all directories under \fIroot\fR/\fIpkgdir\fR/ which contain
+\&\fBopenpkg lsync\fR skips all directories under \fIroot\fR/\fIpkgdir\fR/ which contain
 the pattern \*(L"\-[0\-9]\*(R" in their directory name. On the other hand,
-\&\fIlsync\fR\|(1) follows also symbolic links under \fIroot\fR/\fIpkgdir\fR/.
+\&\fBopenpkg lsync\fR follows also symbolic links under \fIroot\fR/\fIpkgdir\fR/.
 This can be used for installing multiple versions of a package and
 switching between them. For instance, if version 1.0 of package
 \&\*(L"foo\*(R" is installed into directory \fIroot\fR/\fIpkgdir\fR/foo\-1.0,
 version 1.1 into \fIroot\fR/\fIpkgdir\fR/foo\-1.1 and version 1.2 into
-\&\fIroot\fR/\fIpkgdir\fR/foo\-1.2, \fIlsync\fR\|(1) does skip all three. To enable
+\&\fIroot\fR/\fIpkgdir\fR/foo\-1.2, \fBopenpkg lsync\fR does skip all three. To enable
 version 1.1 one just creates a symbolic link \fIroot\fR/\fIpkgdir\fR/foo
-pointing to foo\-1.1. Then \fIlsync\fR\|(1) picks up the files in
+pointing to foo\-1.1. Then \fBopenpkg lsync\fR picks up the files in
 \&\fIroot\fR/\fIpkgdir\fR/foo\-1.1. If you want to temporarily upgrade to
 foo\-1.2, all you have to do is to change the symlink pointing from
 foo\-1.1 to foo\-1.2.
 .IP "\fBTemporarily Deactivated Package\fR" 4
 .IX Item "Temporarily Deactivated Package"
 One can deactivate a package \*(L"foo\*(R" by going to \fIroot\fR/\fIpkgdir\fR/foo/
-and running \*(L"lsync \-\-local \-\-uninstall\*(R", of course. Alternatively
+and running \*(L"openpkg lsync \-\-local \-\-uninstall\*(R", of course. Alternatively
 one can set the sticky bit on the directory \fIroot\fR/\fIpkgdir\fR/foo.
-Then \fIlsync\fR\|(1) also skips the package. Alternatively, assume
+Then \fBopenpkg lsync\fR also skips the package. Alternatively, assume
 package \*(L"foo\*(R" as a whole should not be deactivated, but its
 \&\fIroot\fR/\fIpkgdir\fR/foo/lib directory (usually because this directory
 unfortunately contains non-library files), one just sets the sticky bit
@@ -269,16 +269,16 @@ Display program usage information only.
 Create an initial access layer hierarchy under \fIroot\fR.
 .IP "\fB\-\-nop\fR, \fB\-n\fR" 4
 .IX Item "--nop, -n"
-No Operation \*(-- causes \fIlsync\fR\|(1) to not perform any filesystem
+No Operation \*(-- causes \fBopenpkg lsync\fR to not perform any filesystem
 operations. In conjunction with \fB\-\-trace\fR you can at least see what
 would be executed.
 .IP "\fB\-\-quiet\fR, \fB\-q\fR" 4
 .IX Item "--quiet, -q"
-Forces \fIlsync\fR\|(1) to perform the operations quietly, i.e., without any
+Forces \fBopenpkg lsync\fR to perform the operations quietly, i.e., without any
 verbose messages.
 .IP "\fB\-\-trace\fR, \fB\-t\fR" 4
 .IX Item "--trace, -t"
-Forces \fIlsync\fR\|(1) to show what filesystem operations are performed.
+Forces \fBopenpkg lsync\fR to show what filesystem operations are performed.
 .IP "\fB\-\-local\fR, \fB\-l\fR" 4
 .IX Item "--local, -l"
 This restricts the operations to a local package area. This option can
@@ -296,17 +296,17 @@ remove its files.
 .IP "\fB\-\-root=\fR\fIroot\fR" 4
 .IX Item "--root=root"
 Sets the root directory where the access layer and package subdirectory
-is located. The default can be determined by running \f(CW\*(C`lsync \-\-help\*(C'\fR
+is located. The default can be determined by running \f(CW\*(C`openpkg lsync \-\-help\*(C'\fR
 (see section \*(L"Current configuration\*(R").
 .IP "\fB\-\-pkgdir=\fR\fIpkgdir\fR" 4
 .IX Item "--pkgdir=pkgdir"
 Sets the sub-directory under the root directory where packages are
-located. The default can be determined by running \f(CW\*(C`lsync \-\-help\*(C'\fR (see
+located. The default can be determined by running \f(CW\*(C`openpkg lsync \-\-help\*(C'\fR (see
 section \*(L"Current configuration\*(R").
 .IP "\fB\-\-subdirs=\fR\fIsubdirs\fR[,\fIsubdir\fR,...]" 4
 .IX Item "--subdirs=subdirs[,subdir,...]"
-Sets one or more sub-directories of the access layer on which \fIlsync\fR\|(1)
-should act. The default can be determined by running \f(CW\*(C`lsync \-\-help\*(C'\fR
+Sets one or more sub-directories of the access layer on which \fBopenpkg lsync\fR
+should act. The default can be determined by running \f(CW\*(C`openpkg lsync \-\-help\*(C'\fR
 (see section \*(L"Current configuration\*(R").
 .SH "RESULTS"
 .IX Header "RESULTS"
@@ -330,7 +330,7 @@ For Cable & Wireless Deutschland GmbH, Munich, the old \fBGenOPT\fR
 principle was again needed to manage the \f(CW\*(C`/cw/local\*(C'\fR area on their
 servers. For this in November 2000 the functionality of \fBGenOPT\fR was
 revised, heavily stripped down and finally implemented from scratch. The
-result is the current \fBLSync\fR.
+result is the current \fBopenpkg lsync\fR.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 .Vb 3

+ 24 - 24
openpkg/lsync.pod

@@ -27,11 +27,11 @@
 
 =head1 NAME
 
-B<lsync> - Access Layer Synchronization Tool
+B<openpkg lsync> - Access Layer Synchronization Tool
 
 =head1 SYNOPSIS
 
-B<lsync>
+B<openpkg lsync>
 [B<--version>|B<-v>]
 [B<--help>|B<-h>]
 [B<--init>|B<-i>]
@@ -84,7 +84,7 @@ This activates the Unix manual page
 I<root>B</>I<pkgdir>B</>barB</man/man>I<N>B</>foo as
 I<root>B</man/man>I<N>B</>foo. It can be found by the man(1) tool
 by placing I<root>B</man> into the environment variable C<MANPATH>
-(B<MANPATH="..:>I<root>B</man:..">). Keep in mind that lsync(1)
+(B<MANPATH="..:>I<root>B</man:..">). Keep in mind that B<openpkg lsync>
 activates any files found in the B<man/manI<N>> sub-directory of the
 package, but the man(1) tool usually requires the filename scheme
 fooB<.>I<N> before it can find the file.
@@ -95,7 +95,7 @@ This activates the GNU info page I<root>B</>I<pkgdir>B</>barB</info/>foo
 as I<root>B</info/>foo. It can be found by the info(1) and pinfo(1)
 tools by placing I<root>B</info> into the environment variable
 C<INFOPATH> (B<INFOPATH="..:>I<root>B</info:..">). Keep in mind that
-lsync(1) activates any files found in the B<info/> sub-directory of the
+B<openpkg lsync> activates any files found in the B<info/> sub-directory of the
 package, but the info(1) and pinfo(1) tools usually require the filename
 scheme fooB<.info> before it can find the file.
 
@@ -104,7 +104,7 @@ scheme fooB<.info> before it can find the file.
 This activates the C header I<root>B</>I<pkgdir>B</>barB</include>/foo
 as I<root>B</include/>foo. It can be found by the C/C++ compilers
 by adding I<root>B</include> to their include search path (B<cc ..
--I>I<root>B</include> B<...>). Keep in mind that lsync(1) activates any
+-I>I<root>B</include> B<...>). Keep in mind that B<openpkg lsync> activates any
 files found in the B<include/> sub-directory of the package, but the
 C/C++ compiler usually by convention use the filename scheme fooB<.h>.
 
@@ -116,7 +116,7 @@ the linker they use) by adding I<root>B</lib> to their library search
 path (B<cc .. -L>I<root>B</lib> B<...>). It can be found by the Unix
 Dynamic Loader by adding I<root>B</lib> to the environment variable
 C<LD_LIBRARY_PATH> (B<LD_LIBRARY_PATH="..:>I<root>B</lib:..">).
-Keep in mind that lsync(1) activates any files found in the B<lib/>
+Keep in mind that B<openpkg lsync> activates any files found in the B<lib/>
 sub-directory of the package, but the C/C++ compiler usually require the
 filename scheme B<lib>fooB<.a> and the Unix Dynamic Loader the filename
 scheme B<lib>fooB<.so> before they actually can use the file.
@@ -125,37 +125,37 @@ scheme B<lib>fooB<.so> before they actually can use the file.
 
 It is obvious that more sub-directories in a package installation
 might exist -- for instance B<share/>, B<var/>, B<libexec/>, etc. But
-lsync(1) intentionally does not link files in those directories into
+B<openpkg lsync> intentionally does not link files in those directories into
 corresponding directories of the access layer, because those files do
 not require that they are located in a global area in order to be used.
-So lsync(1) only creates the access layer for files where a common area
+So B<openpkg lsync> only creates the access layer for files where a common area
 is required for (easy) use.
 
 =head1 SPECIAL FEATURES
 
-There are two special features supported by lsync(1):
+There are two special features supported by B<openpkg lsync>:
 
 =over 4
 
 =item B<Run-Command Files>
 
-lsync(1) on startup implicitly reads command line options from
+B<openpkg lsync> on startup implicitly reads command line options from
 C<.lsyncrc> files. They are searched in all parent directories and in
 the callers home directory. Their contents is prepended to the list of
 given command line options.
 
 =item B<Multiple Package Versions>
 
-lsync(1) skips all directories under I<root>/I<pkgdir>/ which contain
+B<openpkg lsync> skips all directories under I<root>/I<pkgdir>/ which contain
 the pattern "-[0-9]" in their directory name. On the other hand,
-lsync(1) follows also symbolic links under I<root>/I<pkgdir>/.
+B<openpkg lsync> follows also symbolic links under I<root>/I<pkgdir>/.
 This can be used for installing multiple versions of a package and
 switching between them. For instance, if version 1.0 of package
 "foo" is installed into directory I<root>/I<pkgdir>/foo-1.0,
 version 1.1 into I<root>/I<pkgdir>/foo-1.1 and version 1.2 into
-I<root>/I<pkgdir>/foo-1.2, lsync(1) does skip all three. To enable
+I<root>/I<pkgdir>/foo-1.2, B<openpkg lsync> does skip all three. To enable
 version 1.1 one just creates a symbolic link I<root>/I<pkgdir>/foo
-pointing to foo-1.1. Then lsync(1) picks up the files in
+pointing to foo-1.1. Then B<openpkg lsync> picks up the files in
 I<root>/I<pkgdir>/foo-1.1. If you want to temporarily upgrade to
 foo-1.2, all you have to do is to change the symlink pointing from
 foo-1.1 to foo-1.2.
@@ -163,9 +163,9 @@ foo-1.1 to foo-1.2.
 =item B<Temporarily Deactivated Package>
 
 One can deactivate a package "foo" by going to I<root>/I<pkgdir>/foo/
-and running "lsync --local --uninstall", of course. Alternatively
+and running "openpkg lsync --local --uninstall", of course. Alternatively
 one can set the sticky bit on the directory I<root>/I<pkgdir>/foo.
-Then lsync(1) also skips the package. Alternatively, assume
+Then B<openpkg lsync> also skips the package. Alternatively, assume
 package "foo" as a whole should not be deactivated, but its
 I<root>/I<pkgdir>/foo/lib directory (usually because this directory
 unfortunately contains non-library files), one just sets the sticky bit
@@ -191,18 +191,18 @@ Create an initial access layer hierarchy under I<root>.
 
 =item B<--nop>, B<-n>
 
-No Operation -- causes lsync(1) to not perform any filesystem
+No Operation -- causes B<openpkg lsync> to not perform any filesystem
 operations. In conjunction with B<--trace> you can at least see what
 would be executed.
 
 =item B<--quiet>, B<-q>
 
-Forces lsync(1) to perform the operations quietly, i.e., without any
+Forces B<openpkg lsync> to perform the operations quietly, i.e., without any
 verbose messages.
 
 =item B<--trace>, B<-t>
 
-Forces lsync(1) to show what filesystem operations are performed.
+Forces B<openpkg lsync> to show what filesystem operations are performed.
 
 =item B<--local>, B<-l>
 
@@ -223,19 +223,19 @@ remove its files.
 =item B<--root=>I<root>
 
 Sets the root directory where the access layer and package subdirectory
-is located. The default can be determined by running C<lsync --help>
+is located. The default can be determined by running C<openpkg lsync --help>
 (see section "Current configuration").
 
 =item B<--pkgdir=>I<pkgdir>
 
 Sets the sub-directory under the root directory where packages are
-located. The default can be determined by running C<lsync --help> (see
+located. The default can be determined by running C<openpkg lsync --help> (see
 section "Current configuration").
 
 =item B<--subdirs=>I<subdirs>[,I<subdir>,...]
 
-Sets one or more sub-directories of the access layer on which lsync(1)
-should act. The default can be determined by running C<lsync --help>
+Sets one or more sub-directories of the access layer on which B<openpkg lsync>
+should act. The default can be determined by running C<openpkg lsync --help>
 (see section "Current configuration").
 
 =back
@@ -263,7 +263,7 @@ For Cable & Wireless Deutschland GmbH, Munich, the old B<GenOPT>
 principle was again needed to manage the C</cw/local> area on their
 servers. For this in November 2000 the functionality of B<GenOPT> was
 revised, heavily stripped down and finally implemented from scratch. The
-result is the current B<LSync>.
+result is the current B<openpkg lsync>.
 
 =head1 AUTHOR