summaryrefslogtreecommitdiff
path: root/src/cmd/nm/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/nm/doc.go')
-rw-r--r--src/cmd/nm/doc.go21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/cmd/nm/doc.go b/src/cmd/nm/doc.go
new file mode 100644
index 000000000..2a37dd835
--- /dev/null
+++ b/src/cmd/nm/doc.go
@@ -0,0 +1,21 @@
+// Copyright 2009 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+
+Nm is a version of the Plan 9 nm command. The original is documented at
+
+ http://plan9.bell-labs.com/magic/man2html/1/nm
+
+It prints the name list (symbol table) for programs compiled by gc as well as the
+Plan 9 C compiler.
+
+This implementation adds the flag -S, which prints each symbol's size
+in decimal after its address.
+
+For reasons of disambiguation it is installed as 6nm although it also serves
+as an 8nm and a 5nm.
+
+*/
+package documentation