Skip to content

Commit aa2ed84

Browse files
urbanjosturbanjost
committed
suggested help text changes
1 parent 401efe6 commit aa2ed84

File tree

2 files changed

+103
-56
lines changed

2 files changed

+103
-56
lines changed

‎docs/index.html‎

Lines changed: 78 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ <H3>DESCRIPTION</H3>
7575
<B>fpm</B>(1) is a package manager that helps you create Fortran projects
7676
from source.
7777
<P>
78-
Most significantly <B>fpm</B>(1) lets you pull upon other <B>fpm</B>(1) packages
78+
Most significantly <B>fpm</B>(1) lets you draw upon other <B>fpm</B>(1) packages
7979
in distributed <B>git</B>(1) repositories as if the packages were a basic
8080
part of your default programming environment, as well as letting
8181
you share your projects with others in a similar manner.
@@ -93,7 +93,7 @@ <H3>SUBCOMMANDS</H3>
9393

9494
</A>
9595
<BLOCKQUOTE>
96-
Valid <B>fpm</B> subcommands are:
96+
Valid <B>fpm</B>(1) subcommands are:
9797
<P>
9898
<PRE>
9999
build [--release] [--list]
@@ -128,12 +128,12 @@ <H3>SUBCOMMAND OPTIONS</H3>
128128
</TD></TR>
129129
<TR valign=top><TD width=6% nowrap>
130130
<B></B><B>--list</B> </TD><TD valign=bottom>
131-
List candidates instead of building or running them.
132-
On the <B>fpm</B> command this shows a brief list of subcommands.
131+
List candidates instead of building or running them. On
132+
the <B>fpm</B>(1) command this shows a brief list of subcommands.
133133
</TD></TR>
134134
<TR valign=top><TD colspan=2>
135135
<B>-- ARGS</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
136-
Arguments to pass to executables/tests
136+
Arguments to pass to executables.
137137
</TD></TR>
138138
<TR valign=top><TD width=6% nowrap>
139139
<B></B><B>--help</B> </TD><TD valign=bottom>
@@ -195,25 +195,52 @@ <H3>DESCRIPTION</H3>
195195

196196
</A>
197197
<BLOCKQUOTE>
198-
"<B>fpm</B> <I>new</I>" creates a <I>new</I> programming project in a <I>new</I> directory.
198+
"<B>fpm</B> <I>new</I>" creates and populates a <I>new</I> programming project directory.
199+
It
200+
<BLOCKQUOTE>
201+
<TABLE cellpadding=3><!-- tsb: "<B>fpm</B> <I>new</I>" creates and populates a <I>new</I> programming project directory.
202+
-->
203+
<TR></TR><TR></TR>
204+
<TR valign=top><TD width=3%>
205+
o
206+
</TD><TD>
207+
creates a directory with the specified name
208+
</TD></TR>
209+
<TR valign=top><TD width=3%>
210+
o
211+
</TD><TD>
212+
runs the command "git init" in that directory
213+
</TD></TR>
214+
<TR valign=top><TD width=3%>
215+
o
216+
</TD><TD>
217+
populates the directory with the default project directories
218+
</TD></TR>
219+
<TR valign=top><TD width=3%>
220+
o
221+
</TD><TD>
222+
adds sample Fortran source files
223+
</TD></TR>
224+
<TR valign=top><TD width=3%>
225+
o
226+
</TD><TD>
227+
adds a ".gitignore" file for ignoring the build/ directory
228+
(where <B>fpm</B>-generated output will be placed)
229+
</TD></TR>
230+
<TR></TR></TABLE></BLOCKQUOTE>
199231
<P>
200-
The "<I>new</I>" subcommand creates a directory with the specified
201-
name and runs the command "git init" in that directory and
202-
populates it with an example "fpm.toml" file, a src/, test/,
203-
and app/ directory with trivial example Fortran source files
204-
and a ".gitignore" file for ignoring the build/ directory
205-
(where <B>fpm</B>-generated output will be placed):
232+
The basic default file structure is
206233
<P>
207234
<PRE>
208-
NAME/
209-
fpm.toml
210-
.gitignore
211-
src/
212-
NAME.f90
213-
app/
214-
main.f90
215-
test/
216-
main.f90
235+
NAME/
236+
fpm.toml
237+
.gitignore
238+
src/
239+
NAME.f90
240+
app/
241+
main.f90
242+
test/
243+
main.f90
217244
<P>
218245
</PRE>
219246
Remember to update the information in the sample "fpm.toml"
@@ -747,19 +774,37 @@ <H3>SEE ALSO</H3>
747774
</A>
748775
<BLOCKQUOTE>
749776
The <B>fpm</B>(1) home page at https://github.com/fortran-lang/<B>fpm</B>
750-
<P>
751-
<PRE>
752-
Version: 0.1.0, Pre-alpha
753-
Program: fpm(1)
754-
Description: A Fortran package manager and build system
755-
Home Page: https://github.com/fortran-lang/fpm
756-
License: MIT
757-
OS Type: Linux
758-
</PRE>
759777
</BLOCKQUOTE>
760-
<P><HR>
761-
<TABLE width=100%><TR> <TD width=33%><I></I></TD> <TD width=33% align=center>untitled ()</TD> <TD align=right width=33%><I>October 17, 2020</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from x.1 using man macros.</FONT>
762-
<br><br><center><img src="images/x.1.gif"></center>
778+
<TABLE cellpadding=3><!-- tsb: The <B>fpm</B>(1) home page at https://github.com/fortran-lang/<B>fpm</B>
779+
-->
780+
<TR></TR><TR></TR>
781+
<TR valign=top><TD colspan=2>
782+
<B>Version:</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
783+
0.1.0, Pre-alpha
784+
<TABLE width=100% cellpadding=3><!-- tsb: 0.1.0, Pre-alpha
785+
-->
786+
<TR></TR><TR></TR>
787+
<TR valign=top><TD colspan=2>
788+
<B>Program:</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
789+
<B>fpm</B>(1)
790+
Description: A Fortran package manager and <I>build</I> system
791+
</TD></TR>
792+
<TR valign=top><TD colspan=2>
793+
<B>Home Page:</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
794+
https://github.com/fortran-lang/<B>fpm</B>
795+
</TD></TR>
796+
<TR valign=top><TD colspan=2>
797+
<B>License:</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
798+
MIT
799+
</TD></TR>
800+
<TR valign=top><TD colspan=2>
801+
<B>OS Type:</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
802+
Linux
803+
</TD></TR>
804+
<TR></TR></TABLE></TD></TR>
805+
<TR></TR></TABLE><P><HR>
806+
<TABLE width=100%><TR> <TD width=33%><I></I></TD> <TD width=33% align=center>untitled ()</TD> <TD align=right width=33%><I>October 18, 2020</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from d68c10d7-7027-443c-9855-663219ca410d using man macros.</FONT>
807+
<br><br><center><img src="images/IMAGE.gif"></center>
763808
</div>
764809
</div>
765810
</body>

‎fpm/src/fpm_command_line.f90‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ subroutine set_help()
327327
' fpm(1) is a package manager that helps you create Fortran projects ', &
328328
' from source. ', &
329329
' ', &
330-
' Most significantly fpm(1) lets you pull upon other fpm(1) packages ', &
330+
' Most significantly fpm(1) lets you draw upon other fpm(1) packages ', &
331331
' in distributed git(1) repositories as if the packages were a basic ', &
332332
' part of your default programming environment, as well as letting ', &
333333
' you share your projects with others in a similar manner. ', &
@@ -340,7 +340,7 @@ subroutine set_help()
340340
' being used you need network connectivity to rebuild from scratch. ', &
341341
' ', &
342342
'SUBCOMMANDS ', &
343-
' Valid fpm subcommands are: ', &
343+
' Valid fpm(1) subcommands are: ', &
344344
' ', &
345345
' build [--release] [--list] ', &
346346
' Compile the packages into the "build/" directory. ', &
@@ -361,9 +361,9 @@ subroutine set_help()
361361
' in "build/*_debug/". When this flag is present build ', &
362362
' output goes into "build/*_release/" and common compiler ', &
363363
' optimization flags are used. ', &
364-
' --list List candidates instead of building or running them. ', &
365-
' On the fpm command this shows a brief list of subcommands.', &
366-
' -- ARGS Arguments to pass to executables/tests ', &
364+
' --list List candidates instead of building or running them. On ', &
365+
' the fpm(1) command this shows a brief list of subcommands.', &
366+
' -- ARGS Arguments to pass to executables. ', &
367367
' --help Show help text and exit. Valid for all subcommands. ', &
368368
' --version Show version information and exit. Valid for all ', &
369369
' subcommands. ', &
@@ -542,24 +542,26 @@ subroutine set_help()
542542
' fpm new --help|--version ', &
543543
' ', &
544544
'DESCRIPTION ', &
545-
' "fpm new" creates a new programming project in a new directory. ', &
546-
' ', &
547-
' The "new" subcommand creates a directory with the specified ', &
548-
' name and runs the command "git init" in that directory and ', &
549-
' populates it with an example "fpm.toml" file, a src/, test/, ', &
550-
' and app/ directory with trivial example Fortran source files ', &
551-
' and a ".gitignore" file for ignoring the build/ directory ', &
552-
' (where fpm-generated output will be placed): ', &
553-
' ', &
554-
' NAME/ ', &
555-
' fpm.toml ', &
556-
' .gitignore ', &
557-
' src/ ', &
558-
' NAME.f90 ', &
559-
' app/ ', &
560-
' main.f90 ', &
561-
' test/ ', &
562-
' main.f90 ', &
545+
' "fpm new" creates and populates a new programming project directory. ', &
546+
' It ', &
547+
' o creates a directory with the specified name ', &
548+
' o runs the command "git init" in that directory ', &
549+
' o populates the directory with the default project directories ', &
550+
' o adds sample Fortran source files ', &
551+
' o adds a ".gitignore" file for ignoring the build/ directory ', &
552+
' (where fpm-generated output will be placed) ', &
553+
' ', &
554+
' The basic default file structure is ', &
555+
' ', &
556+
' NAME/ ', &
557+
' fpm.toml ', &
558+
' .gitignore ', &
559+
' src/ ', &
560+
' NAME.f90 ', &
561+
' app/ ', &
562+
' main.f90 ', &
563+
' test/ ', &
564+
' main.f90 ', &
563565
' ', &
564566
' Remember to update the information in the sample "fpm.toml" ', &
565567
' file with your name and e-mail address. ', &

0 commit comments

Comments
 (0)