jianmu
/
lammps
forked from lijiext/lammps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
lammps/doc/src/log.rst

50 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Add documentation files in RST format This is the first step for moving the documentation format from *.txt to the *.rst format. In the last years we've been automatically converting txt files from Steve's markup into RST to generate the documentation pages via Sphinx. The decision has now been made to fully migrate to RST and avoid the conversion in the future. This will enable us to fully use RST and Sphinx to improve the documentation. For the intermediate period, while there are still pending PRs with documentation changes, we will keep both source files and update the RST files accordingly.
2019-08-23 01:24:26 +08:00
.. index:: log
log command
===========
Syntax
""""""
.. parsed-literal::
log file keyword
* file = name of new logfile
* keyword = *append* if output should be appended to logfile (optional)
Examples
""""""""
more conversion of parsed-literal to code-block and a bunch of other issues
2020-03-12 20:04:26 +08:00
.. code-block:: LAMMPS
Add documentation files in RST format This is the first step for moving the documentation format from *.txt to the *.rst format. In the last years we've been automatically converting txt files from Steve's markup into RST to generate the documentation pages via Sphinx. The decision has now been made to fully migrate to RST and avoid the conversion in the future. This will enable us to fully use RST and Sphinx to improve the documentation. For the intermediate period, while there are still pending PRs with documentation changes, we will keep both source files and update the RST files accordingly.
2019-08-23 01:24:26 +08:00
log log.equil
log log.equil append
Description
"""""""""""
This command closes the current LAMMPS log file, opens a new file with
the specified name, and begins logging information to it. If the
specified file name is *none*\ , then no new log file is opened. If the
optional keyword *append* is specified, then output will be appended
to an existing log file, instead of overwriting it.
If multiple processor partitions are being used, the file name should
be a variable, so that different processors do not attempt to write to
the same log file.
The file "log.lammps" is the default log file for a LAMMPS run. The
name of the initial log file can also be set by the :doc:`-log command-line switch <Run_options>`.
Restrictions
""""""""""""
none
**Related commands:** none
Default
"""""""
The default LAMMPS log file is named log.lammps