some clarifications and corrections on the wildcard command line docs

This commit is contained in:
Axel Kohlmeyer
2018-11-26 14:46:39 -05:00
parent bfaa2e9ee1
commit 79b3e9e27d

View File

@ -354,29 +354,31 @@ the LAMMPS simulation domain.
:line
[-restart2data restartfile (remap) datafile keyword value ...] :link(restart2data)
[-restart2data restartfile \[remap\] datafile keyword value ...]
:link(restart2data)
Convert the restart file into a data file and immediately exit. This
is the same operation as if the following 2-line input script were
run:
read_restart restartfile (remap)
read_restart restartfile \[remap\]
write_data datafile keyword value ... :pre
The specified restartfile and/or datafile can have the wild-card
character "*". The restartfile can also have the wild-card character
"%". The meaning of these characters is explained on the
The specified restartfile and/or datafile name may contain the wild-card
character "*". The restartfile name may also contain the wild-card
character "%". The meaning of these characters is explained on the
"read_restart"_read_restart.html and "write_data"_write_data.html doc
pages. The use of "%" means that a parallel restart file can be read.
Note that a filename such as file.* will need to be enclosed in quotes
to avoid shell expansion of the "*" character.
Note that a filename such as file.* may need to be enclosed in quotes or
the "*" character prefixed with a backslash ("\") to avoid shell
expansion of the "*" character.
Following restartfile, the optional word "remap" can be used. This
has the effect of adding it to the "read_restart"_read_restart.html
command, as explained on its doc page. This is useful if reading the
restart file triggers an error that atoms have been lost. In that
case, use of the remap flag should allow the data file to still be
produced.
Following restartfile argument, the optional word "remap" may be used.
This has the same effect like adding it to a
"read_restart"_read_restart.html command, and operates as explained on
its doc page. This is useful if reading the restart file triggers an
error that atoms have been lost. In that case, use of the remap flag
should allow the data file to still be produced.
The syntax following restartfile (or remap), namely
@ -388,29 +390,30 @@ optional keyword/value settings.
:line
[-restart2dump restartfile (remap) group-ID dumpstyle dumpfile arg1 arg2 ...] :link(restart2dump)
[-restart2dump restartfile \[remap\] group-ID dumpstyle dumpfile arg1 arg2 ...] :link(restart2dump)
Convert the restart file into a dump file and immediately exit. This
is the same operation as if the following 2-line input script were
run:
read_restart restartfile (remap)
read_restart restartfile \[remap\]
write_dump group-ID dumpstyle dumpfile arg1 arg2 ... :pre
Note that the specified restartfile and dumpfile can have wild-card
characters ("*","%") as explained on the
Note that the specified restartfile and dumpfile names may contain
wild-card characters ("*","%") as explained on the
"read_restart"_read_restart.html and "write_dump"_write_dump.html doc
pages. The use of "%" means that a parallel restart file and/or
parallel dump file can be read and/or written. Note that a filename
such as file.* will need to be enclosed in quotes to avoid shell
expansion of the "*" character.
such as file.* may need to be enclosed in quotes or the "*" character
prefixed with a backslash ("\") to avoid shell expansion of the "*"
character.
Note that following restartfile, the optional word "remap" can be
used. This has the effect as adding it to the
"read_restart"_read_restart.html command, as explained on its doc
page. This is useful if reading the restart file triggers an error
that atoms have been lost. In that case, use of the remap flag should
allow the dump file to still be produced.
Note that following the restartfile argument, the optional word "remap"
can be used. This has the effect as adding it to the
"read_restart"_read_restart.html command, as explained on its doc page.
This is useful if reading the restart file triggers an error that atoms
have been lost. In that case, use of the remap flag should allow the
dump file to still be produced.
The syntax following restartfile (or remap), namely
@ -524,7 +527,7 @@ option is equivalent to putting the line "variable name index value1
value2 ..." at the beginning of the input script. Defining an index
variable as a command-line argument overrides any setting for the same
index variable in the input script, since index variables cannot be
re-defined.
re-defined.
See the "variable"_variable.html command for more info on defining
index and other kinds of variables and the "Commands