diff options
author | init current directory[i] <urbanjost@comcast.net> | 2020-10-18 11:45:38 -0400 |
---|---|---|
committer | init current directory[i] <urbanjost@comcast.net> | 2020-10-18 11:45:38 -0400 |
commit | aa2ed841bedd6940a34e425f04857c2fce65ab6c (patch) | |
tree | 4f4c0cb1918f176a978f3b3fd7514f624b630530 | |
parent | 401efe6555d8ebbe6ffa63e8bda43cc8ba42546b (diff) | |
download | fpm-aa2ed841bedd6940a34e425f04857c2fce65ab6c.tar.gz fpm-aa2ed841bedd6940a34e425f04857c2fce65ab6c.zip |
suggested help text changes
-rw-r--r-- | docs/index.html | 111 | ||||
-rw-r--r-- | fpm/src/fpm_command_line.f90 | 48 |
2 files changed, 103 insertions, 56 deletions
diff --git a/docs/index.html b/docs/index.html index f351396..edd199c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -75,7 +75,7 @@ a.existingWikiWord[title]{ //border: 1px dashed #BBB; } <B>fpm</B>(1) is a package manager that helps you create Fortran projects from source. <P> -Most significantly <B>fpm</B>(1) lets you pull upon other <B>fpm</B>(1) packages +Most significantly <B>fpm</B>(1) lets you draw upon other <B>fpm</B>(1) packages in distributed <B>git</B>(1) repositories as if the packages were a basic part of your default programming environment, as well as letting you share your projects with others in a similar manner. @@ -93,7 +93,7 @@ being used you need network connectivity to rebuild from scratch. </A> <BLOCKQUOTE> -Valid <B>fpm</B> subcommands are: +Valid <B>fpm</B>(1) subcommands are: <P> <PRE> build [--release] [--list] @@ -128,12 +128,12 @@ optimization flags are used. </TD></TR> <TR valign=top><TD width=6% nowrap> <B></B><B>--list</B> </TD><TD valign=bottom> -List candidates instead of building or running them. -On the <B>fpm</B> command this shows a brief list of subcommands. +List candidates instead of building or running them. On +the <B>fpm</B>(1) command this shows a brief list of subcommands. </TD></TR> <TR valign=top><TD colspan=2> <B>-- ARGS</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD> -Arguments to pass to executables/tests +Arguments to pass to executables. </TD></TR> <TR valign=top><TD width=6% nowrap> <B></B><B>--help</B> </TD><TD valign=bottom> @@ -195,25 +195,52 @@ The <B>fpm</B>(1) home page at https://github.com/fortran-lang/<B>fpm</B> </A> <BLOCKQUOTE> -"<B>fpm</B> <I>new</I>" creates a <I>new</I> programming project in a <I>new</I> directory. +"<B>fpm</B> <I>new</I>" creates and populates a <I>new</I> programming project directory. +It +<BLOCKQUOTE> +<TABLE cellpadding=3><!-- tsb: "<B>fpm</B> <I>new</I>" creates and populates a <I>new</I> programming project directory. + --> +<TR></TR><TR></TR> +<TR valign=top><TD width=3%> +o +</TD><TD> +creates a directory with the specified name +</TD></TR> +<TR valign=top><TD width=3%> +o +</TD><TD> +runs the command "git init" in that directory +</TD></TR> +<TR valign=top><TD width=3%> +o +</TD><TD> +populates the directory with the default project directories +</TD></TR> +<TR valign=top><TD width=3%> +o +</TD><TD> +adds sample Fortran source files +</TD></TR> +<TR valign=top><TD width=3%> +o +</TD><TD> +adds a ".gitignore" file for ignoring the build/ directory +(where <B>fpm</B>-generated output will be placed) +</TD></TR> +<TR></TR></TABLE></BLOCKQUOTE> <P> -The "<I>new</I>" subcommand creates a directory with the specified -name and runs the command "git init" in that directory and -populates it with an example "fpm.toml" file, a src/, test/, -and app/ directory with trivial example Fortran source files -and a ".gitignore" file for ignoring the build/ directory -(where <B>fpm</B>-generated output will be placed): +The basic default file structure is <P> <PRE> - NAME/ - fpm.toml - .gitignore - src/ - NAME.f90 - app/ - main.f90 - test/ - main.f90 + NAME/ + fpm.toml + .gitignore + src/ + NAME.f90 + app/ + main.f90 + test/ + main.f90 <P> </PRE> Remember to update the information in the sample "fpm.toml" @@ -747,19 +774,37 @@ display a short <I>list</I> of <B>fpm</B>(1) subcommands </A> <BLOCKQUOTE> The <B>fpm</B>(1) home page at https://github.com/fortran-lang/<B>fpm</B> -<P> -<PRE> - Version: 0.1.0, Pre-alpha - Program: fpm(1) - Description: A Fortran package manager and build system - Home Page: https://github.com/fortran-lang/fpm - License: MIT - OS Type: Linux -</PRE> </BLOCKQUOTE> -<P><HR> -<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> -<br><br><center><img src="images/x.1.gif"></center> +<TABLE cellpadding=3><!-- tsb: The <B>fpm</B>(1) home page at https://github.com/fortran-lang/<B>fpm</B> + --> +<TR></TR><TR></TR> +<TR valign=top><TD colspan=2> +<B>Version:</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD> +0.1.0, Pre-alpha +<TABLE width=100% cellpadding=3><!-- tsb: 0.1.0, Pre-alpha + --> +<TR></TR><TR></TR> +<TR valign=top><TD colspan=2> +<B>Program:</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD> +<B>fpm</B>(1) +Description: A Fortran package manager and <I>build</I> system +</TD></TR> +<TR valign=top><TD colspan=2> +<B>Home Page:</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD> +https://github.com/fortran-lang/<B>fpm</B> +</TD></TR> +<TR valign=top><TD colspan=2> +<B>License:</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD> +MIT +</TD></TR> +<TR valign=top><TD colspan=2> +<B>OS Type:</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD> +Linux +</TD></TR> +<TR></TR></TABLE></TD></TR> +<TR></TR></TABLE><P><HR> +<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> +<br><br><center><img src="images/IMAGE.gif"></center> </div> </div> </body> diff --git a/fpm/src/fpm_command_line.f90 b/fpm/src/fpm_command_line.f90 index 0efc076..1975602 100644 --- a/fpm/src/fpm_command_line.f90 +++ b/fpm/src/fpm_command_line.f90 @@ -327,7 +327,7 @@ contains ' fpm(1) is a package manager that helps you create Fortran projects ', & ' from source. ', & ' ', & - ' Most significantly fpm(1) lets you pull upon other fpm(1) packages ', & + ' Most significantly fpm(1) lets you draw upon other fpm(1) packages ', & ' in distributed git(1) repositories as if the packages were a basic ', & ' part of your default programming environment, as well as letting ', & ' you share your projects with others in a similar manner. ', & @@ -340,7 +340,7 @@ contains ' being used you need network connectivity to rebuild from scratch. ', & ' ', & 'SUBCOMMANDS ', & - ' Valid fpm subcommands are: ', & + ' Valid fpm(1) subcommands are: ', & ' ', & ' build [--release] [--list] ', & ' Compile the packages into the "build/" directory. ', & @@ -361,9 +361,9 @@ contains ' in "build/*_debug/". When this flag is present build ', & ' output goes into "build/*_release/" and common compiler ', & ' optimization flags are used. ', & - ' --list List candidates instead of building or running them. ', & - ' On the fpm command this shows a brief list of subcommands.', & - ' -- ARGS Arguments to pass to executables/tests ', & + ' --list List candidates instead of building or running them. On ', & + ' the fpm(1) command this shows a brief list of subcommands.', & + ' -- ARGS Arguments to pass to executables. ', & ' --help Show help text and exit. Valid for all subcommands. ', & ' --version Show version information and exit. Valid for all ', & ' subcommands. ', & @@ -542,24 +542,26 @@ contains ' fpm new --help|--version ', & ' ', & 'DESCRIPTION ', & - ' "fpm new" creates a new programming project in a new directory. ', & - ' ', & - ' The "new" subcommand creates a directory with the specified ', & - ' name and runs the command "git init" in that directory and ', & - ' populates it with an example "fpm.toml" file, a src/, test/, ', & - ' and app/ directory with trivial example Fortran source files ', & - ' and a ".gitignore" file for ignoring the build/ directory ', & - ' (where fpm-generated output will be placed): ', & - ' ', & - ' NAME/ ', & - ' fpm.toml ', & - ' .gitignore ', & - ' src/ ', & - ' NAME.f90 ', & - ' app/ ', & - ' main.f90 ', & - ' test/ ', & - ' main.f90 ', & + ' "fpm new" creates and populates a new programming project directory. ', & + ' It ', & + ' o creates a directory with the specified name ', & + ' o runs the command "git init" in that directory ', & + ' o populates the directory with the default project directories ', & + ' o adds sample Fortran source files ', & + ' o adds a ".gitignore" file for ignoring the build/ directory ', & + ' (where fpm-generated output will be placed) ', & + ' ', & + ' The basic default file structure is ', & + ' ', & + ' NAME/ ', & + ' fpm.toml ', & + ' .gitignore ', & + ' src/ ', & + ' NAME.f90 ', & + ' app/ ', & + ' main.f90 ', & + ' test/ ', & + ' main.f90 ', & ' ', & ' Remember to update the information in the sample "fpm.toml" ', & ' file with your name and e-mail address. ', & |