Unverified Commit a8f1fe8f authored by Steve Plimpton's avatar Steve Plimpton Committed by GitHub
Browse files

Merge pull request #1078 from junghans/manpage

added manpage from debian package
parents c61f9248 0661a800
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -1063,6 +1063,7 @@ if(BUILD_EXE)
  
  set_target_properties(lmp PROPERTIES OUTPUT_NAME lmp${LAMMPS_MACHINE})
  install(TARGETS lmp DESTINATION ${CMAKE_INSTALL_BINDIR})
  install(FILES ${LAMMPS_DOC_DIR}/lammps.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 RENAME lmp${LAMMPS_MACHINE}.1)
  if(ENABLE_TESTING)
    add_test(ShowHelp lmp${LAMMPS_MACHINE} -help)
  endif()

doc/lammps.1

0 → 100644
+45 −0
Original line number Diff line number Diff line
.TH LAMMPS "2018-08-22"
.SH NAME
.B LAMMPS
\- Molecular Dynamics Simulator.

.SH SYNOPSIS
.B lmp 
-in in.file

or

mpirun \-np 2 
.B lmp 
-in in.file

.SH DESCRIPTION
.B LAMMPS 
LAMMPS is a classical molecular dynamics code, and an acronym for Large-scale 
Atomic/Molecular Massively Parallel Simulator. LAMMPS has potentials for soft 
materials (biomolecules, polymers) and solid-state materials (metals, 
semiconductors) and coarse-grained or mesoscopic systems. It can be used to 
model atoms or, more generically, as a parallel particle simulator at the 
atomic, meso, or continuum scale.

See http://lammps.sandia.gov/ for documentation.

.SH OPTIONS
See https://lammps.sandia.gov/doc/Run_options.html for details on
command-line options.

.SH COPYRIGHT 
© 2003--2018 Sandia Corporation

This package is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This package is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

On Debian systems, the complete text of the GNU General
Public License can be found in `/usr/share/common-licenses/GPL-2'.