0.50: added man pages

README.md

@@ -1,12 +1,15 @@
 # helmparms3d
 
+## About
+
 The 3D Helmert transformation is a frequently used method in geodesy
 to produce transformations between different Cartesian coordinate systems:
-
+```
 Xt=T+sRX (1)
+```
 
 where
-
+```
 Xt = transformed coordinate vector
 
 X = initial coordinate vector
@@ -18,54 +21,63 @@ R = rotation matrix including rx, ry, rz
 rx, ry, rz = rotations around the coordinate axes
 
 s = scale factor
+```
 
 Seven parameters are required for this kind of transformation
 and can be calculated from a set of at least three point correspondences.
 helmparms3d (a free command-line tool) reads two ASCII point-files and
 calculates all necessary papameters for Helmert transformation.
 All parameters are written to an ASCII file for further computations.
 
-Build:
+## Development
 
-       make
+Build:
+```sh
+make
+```
 
 Install:
-
-       sudo make install
+```sh
+sudo make install
+```
 
 Uninstall:
+```sh
+sudo make uninstall
+```
 
-       sudo make uninstall
+## Use
 
-       
 Parameter computation:
+```sh
+helmparms3d [xyz_src_points] [xyz_dest_points] [helmert_param_filename]
+```
 
-       helmparms3d xyz_src_points xyz_dest_points helmert_param_filename
-       
 Transformation:
-
-       helmert3d [xyz_filename] [helmert_param_filename]
+```sh
+helmert3d [xyz_filename] [helmert_param_filename]
+```
 
-helmert parameter file format:
+## Files
 
+Helmert parameter file format:
+```
  r11 r12 r13
-
  r21 r22 r23
-
  r31 r32 r33
-
  tx ty tz
-
  m
+```
 
-xyz data file format:
-
+XYZ data file format:
+```
  x[1] y[1] z[1]
-
  ..   ..   ..
-
  ..   ..   ..
-
  x[n] y[n] z[n]
-
+```
+
+----
+
+https://github.com/dr-ni/helmparms3d
 

man/man1/helmert3d.1

@@ -0,0 +1,39 @@
+.TH "helmert3d" 1 0.50 "26 Oct 2020" "User Manual"
+
+.SH NAME
+helmert3d
+
+.SH DESCRIPTION
+The 3D Helmert transformation.
+
+.SH SYNOPSIS
+helmert3d [xyz_filename] [helmert_param_filename]
+
+.SH FILES
+.TP
+xyz data file format:
+ x[1] y[1] z[1]
+ ..   ..   ..
+ ..   ..   ..
+ x[n] y[n] z[n]
+.TP
+helmert parameter file format:
+ r11 r12 r13
+ r21 r22 r23
+ r31 r32 r33
+ tx ty tz
+ m
+
+.SH EXAMPLE
+helmert3d examples/testpoints_src.txt examples/testpoints_params.txt
+
+.SH COPYRIGHT
+Copyright (C) 2011 Uwe Niethammer <[email protected]>
+ All rights reserved.
+
+.SH SEE ALSO
+ helmparms3d(1)
+
+.SH CONTACTS
+ Website: http://helmparms3d.sourceforge.net/, https://github.com/dr-ni/helmparms3d
+ Email: [email protected]

man/man1/helmparms3d.1

@@ -0,0 +1,39 @@
+.TH "helmparms3d" 1 0.50 "26 Oct 2020" "User Manual"
+
+.SH NAME
+helmparms3d
+
+.SH DESCRIPTION
+The parameter computation for 3D Helmert transformation.
+
+.SH SYNOPSIS
+helmparms3d [xyz_src_points] [xyz_dest_points] [helmert_param_filename]
+
+.SH FILES
+.TP
+xyz data file format:
+ x[1] y[1] z[1]
+ ..   ..   ..
+ ..   ..   ..
+ x[n] y[n] z[n]
+.TP
+helmert parameter file format:
+ r11 r12 r13
+ r21 r22 r23
+ r31 r32 r33
+ tx ty tz
+ m
+
+.SH EXAMPLE
+helmparms3d examples/testpoints_src.txt examples/testpoints_dest.txt examples/testpoints_params.txt
+
+.SH COPYRIGHT
+Copyright (C) 2011 Uwe Niethammer <[email protected]>
+ All rights reserved.
+
+.SH SEE ALSO
+ helmert3d(1)
+
+.SH CONTACTS
+ Website: http://helmparms3d.sourceforge.net/, https://github.com/dr-ni/helmparms3d
+ Email: [email protected]