summaryrefslogtreecommitdiff
path: root/pkgtools
diff options
context:
space:
mode:
authorwiz <wiz@pkgsrc.org>2017-07-18 18:41:23 +0000
committerwiz <wiz@pkgsrc.org>2017-07-18 18:41:23 +0000
commit44ecdcd2fe7a1bcd000340500abc53fa5b83287c (patch)
tree2bb71f7db10a2013e03ac117f6a302c4a15ecf8e /pkgtools
parent9cd8b9f1aa40e2c5688327760fdf7765d8e25879 (diff)
downloadpkgsrc-44ecdcd2fe7a1bcd000340500abc53fa5b83287c.tar.gz
New sentence, new line.
Sort sections. Remove trailing whitespace. Fix Dt argument
Diffstat (limited to 'pkgtools')
-rw-r--r--pkgtools/R2pkg/files/R2pkg.866
1 files changed, 38 insertions, 28 deletions
diff --git a/pkgtools/R2pkg/files/R2pkg.8 b/pkgtools/R2pkg/files/R2pkg.8
index 7876fa264d6..d43734550ac 100644
--- a/pkgtools/R2pkg/files/R2pkg.8
+++ b/pkgtools/R2pkg/files/R2pkg.8
@@ -1,4 +1,4 @@
-.\" $NetBSD: R2pkg.8,v 1.2 2017/07/18 17:24:32 brook Exp $
+.\" $NetBSD: R2pkg.8,v 1.3 2017/07/18 18:41:23 wiz Exp $
.\"
.\" Copyright (c) 2014,2015,2016,2017
.\" Brook Milligan. All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\"
.Dd February 23, 2017
-.Dt R2pkg 8
+.Dt R2PKG 8
.Os
.Sh NAME
.Nm R2pkg
@@ -46,13 +46,15 @@ takes the name of an R
.Ar package
that should be turned into a
.Xr pkgsrc 7
-package in the current directory. The generated package includes a
+package in the current directory.
+The generated package includes a
.Pa Makefile
-and a mostly complete set of files to get the package going. However,
+and a mostly complete set of files to get the package going.
+However,
the files should be reviewed and perhaps adjusted manually after
.Nm
-has finished its job. To help with this, the original versions of
-files created by
+has finished its job.
+To help with this, the original versions of files created by
.Nm
are preserved for reference.
.Pp
@@ -69,8 +71,9 @@ file on CRAN, which is automatically fetched by
.Nm .
Likewise, the
.Pa DESCR
-file is populated with information from the same file. After
-.Pa Makefile
+file is populated with information from the same file.
+After
+.Pa Makefile
and
.Pa DESCR
are completed,
@@ -96,14 +99,15 @@ However, this file must be removed as it is not part of a
package.
.It Fl E Ar editor
Use
-.Ar editor
+.Ar editor
instead of the user's default editor.
.It Fl R Ar dependency_file
Process dependency packages recursively using
.Pa dependency_file
-to record dependency information. This option is intended for
-internal use only to implement recursion over dependencies. Instead,
-the
+to record dependency information.
+This option is intended for
+internal use only to implement recursion over dependencies.
+Instead, the
.Fl r
option should be used to select recursion.
.It Fl V
@@ -115,12 +119,15 @@ Produce a short help message.
.It Fl q
Do not produce status messages along the way.
.It Fl r
-Process dependency packages recursively. A
+Process dependency packages recursively.
+A
.Pa depends
file is created that lists the dependencies in
.Xr tsort 1
-order. This is likely the best order for testing the resulting
-dependency packages. In particular, a useful strategy for creating
+order.
+This is likely the best order for testing the resulting
+dependency packages.
+In particular, a useful strategy for creating
packages recursively is to (i) run
.Nm
with the
@@ -129,8 +136,8 @@ option, (ii) fix all the leaf packages, (iii) rerun
.Nm
with the
.Fl r
-option, and (iv) continue until all packages are created. Repeating
-runs of
+option, and (iv) continue until all packages are created.
+Repeating runs of
.Nm
once the leaf dependencies are moved into the correct categories will
allow the program to capture the correct dependencies in each
@@ -145,8 +152,8 @@ must be run in an R package directory, which is assumed to be named as
The name of the package to be updated will be taken from the directory
name and need not be given on the command line.
.It Fl v
-Generate verbose output. This may be repeated to increase the
-verbosity.
+Generate verbose output.
+This may be repeated to increase the verbosity.
.El
.Sh ENVIRONMENT
The following environment variables affect the execution of
@@ -159,7 +166,8 @@ and
.Pa DESCR .
.It Ev CRAN_URL
The URL to the CRAN mirror for downloading the package's DESCRIPTION
-file. By default,
+file.
+By default,
.Pa ftp://cran.r-project.org .
.El
.Sh EXAMPLES
@@ -174,23 +182,25 @@ package for the R package
Remember to test the resulting package and remove any extra files
created by
.Nm .
+.Sh SEE ALSO
+.Xr pkgsrc 7
+.Sh AUTHORS
+.Nm
+was written by
+.An Brook Milligan Aq Mt brook@NetBSD.org .
.Sh BUGS
.Nm
does not create a finished package; instead, it facilitates the task.
However, the resulting files must be reviewed and possibly edited by
-hand. Although dependencies are included in the generated
+hand.
+Although dependencies are included in the generated
.Pa Makefile ,
they are not fully analyzed and likely have incorrect category
-information. Packages created recursively for dependencies are placed
+information.
+Packages created recursively for dependencies are placed
in a newly created, nonstandard
.Pa pkgsrc/R
category directory and must be moved to appropriate category
directories within
.Xr pkgsrc 7
and checked for correctness.
-.Sh SEE ALSO
-.Xr pkgsrc 7
-.Sh AUTHORS
-.Nm
-was written by
-.An Brook Milligan Aq Mt brook@NetBSD.org .