document sample usage in scmap

[perl/schtarr.git] / scmap

diff --git a/scmap b/scmap
index 596a835081e6a265d2e7f3b992ba045e34f030bb..5167e01484b48202cf1178361035c8b4657d7d5e 100755 (executable)
--- a/scmap
+++ b/scmap
@@ -101,3 +101,15 @@ if (defined $mapsep{$SHOWMAP}) {
        }
 }
 
+=head1 scmap
+
+From replay:
+
+       old/screptomap somereplay.rep | ./scmap -m=ppm > map.ppm
+
+From map:
+
+       ./scmtomap starcraft/maps/ladder/'(4)Lost Temple.scm'
+       ./scmap -m=ppm < file000001.xxx > map.ppm
+
+=cut