diff --git a/mkproj.1 b/mkproj.1 index 4b42dfe..24480ec 100644 --- a/mkproj.1 +++ b/mkproj.1 @@ -1,4 +1,4 @@ -.Dd December 27, 2024 +.Dd December 31, 2024 .Dt mkproj 1 .Os .Sh NAME @@ -139,9 +139,8 @@ exits 0 on success, and 1 if an error occurs. The project created by .Nm has the following features. -.Ss Without Project Type Options -Without any options, a full-featured project for a tool will be created, with -the following layout: +.Ss Normal Tool Project +This creates a full-featured project for a tool, with the following layout: .Bd -literal mytool |-- Makefile @@ -239,13 +238,13 @@ below for more information. .It tests directory Subdirectory for unit tests, using the Boost Unit Test Framework. .El -.Ss Filter Project Type -The filter project has an identical structure as the normal type, but adds some -functionality to make the tool behave as a real UNIX filter. +.Ss Filter Tool Project +The filter tool project has an identical structure as the normal type, but adds +some functionality to make the tool behave as a real UNIX filter. See .Sx Tool Features below for more information. -.Ss Library Project Type +.Ss Library Project The library project has been set up to produce a static and dynamic library from your sources. Its directory structure is almost identical to that of a tool. @@ -256,8 +255,9 @@ When building the library, a static and dynamic library are produced, containing by default a single function which can return a version string. .Pp TODO describe lib header generation, honoring @exclude -.Ss Simple Project Type -The simple project is just a directory with a single source file and a Makefile. +.Ss Simple Tool Project +The simple tool project is just a directory with a single source file and a +Makefile. The idea is that you use this for simple, quick proof-of-concept tools. Here, the source file has the same name as the project, and is almost empty, so nothing is in the way to make it do what you want. @@ -268,6 +268,8 @@ as well as a but no more. Possible library dependencies should be added to the Makefile. .Ss Makefile targets +The description below is valid for all project types, except the simple tool +project. .Bl -tag -width Ds .It make Use this to compile and link your tool.