[완료] man 페이지를 만들려면 어떻게 해야 하나요?

mg2000의 이미지

안녕하세요.

"man 함수명" 이런식으로 하면, 해당 함수에 대한 도움말을 볼 수 있잖아요.

만약 제가 이런 페이지를 만들려고 하면 어떻게 해야 하는 거죠?

제가 만든 so의 도움말도 이런식으로 볼 수 있게 해 주면 좋을 것 같아서요.

wkpark의 이미지

http://wiki.kldp.org/wiki.php/ManPage 한번 가보시고 참여해보시길 바랍니다~

그냥 하나 만드실 계획이시라면, 적당히 짧은 man페이지 하나 찾아서 zcat /usr/share/man/man?/어쩌구.gz > my.txt를 받아
이것을 적절히 편집하시고

LANG=ko_KR.UTF-8 groff -Tutf8 -man my.txt 하시면 출력을 확인하실 수 있습니다. (이경우 UTF-8로 편집한 man페이지임)

http://man.kldp.org/wiki를 가시면 이 모든 과정을 위키상에서 하실 수 있습니다~

온갖 참된 삶은 만남이다 --Martin Buber

feanor의 이미지

man 페이지는 roff 언어를 사용합니다. 웹 페이지가 HTML 언어를 사용하는 것과 같습니다.

예를 들어 다음과 같은 내용으로 test.1 파일을 만듭니다.

.TH TEST 1
.SH NAME
test - this is a test
.SH SYNOPSIS
.B test --help
.SH OPTIONS
.TP
.B -h, --help
Print a help message and exit.

마침표로 시작하는 줄에서 첫번째 빈칸까지를 태그, 줄의 나머지를 내용 등으로 생각하시면 얼추 맞습니다. man 페이지에서 사용하는 roff 문법에 대한 자세한 내용은 groff_man(7) 페이지를 보시면 됩니다.

결과를 확인해 보려면 man -l test.1을 실행합니다. -l 옵션은 local file을 보겠다는 뜻입니다. -l 없이 보려면 파일을 /usr/share/man/man1 아래로 복사하면 됩니다.

wkpark의 이미지

예 man의 -l 옵션 사용하시면 되겠네요. man명령은 내부적으로 groff 명령을 사용하며,
배포판의 groff 버전에 따라서 -Tutf8이 작동하지 않을 수 있습니다~
혹 man 명령이 제대로 작동하지 않고 화면에 이상한 출력을 보여준다면 groff명령을 직접쓰시면 될 듯

온갖 참된 삶은 만남이다 --Martin Buber

mg2000의 이미지

답변 주신 분들 모두 감사드립니다.

알려주신 내용을 바탕으로 한번 만들어 봐야겠네요.

댓글 달기

Filtered HTML

  • 텍스트에 BBCode 태그를 사용할 수 있습니다. URL은 자동으로 링크 됩니다.
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param><hr>
  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.

BBCode

  • 텍스트에 BBCode 태그를 사용할 수 있습니다. URL은 자동으로 링크 됩니다.
  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param>
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.

Textile

  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • You can use Textile markup to format text.
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param><hr>

Markdown

  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • Quick Tips:
    • Two or more spaces at a line's end = Line break
    • Double returns = Paragraph
    • *Single asterisks* or _single underscores_ = Emphasis
    • **Double** or __double__ = Strong
    • This is [a link](http://the.link.example.com "The optional title text")
    For complete details on the Markdown syntax, see the Markdown documentation and Markdown Extra documentation for tables, footnotes, and more.
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param><hr>

Plain text

  • HTML 태그를 사용할 수 없습니다.
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.
  • 줄과 단락은 자동으로 분리됩니다.
댓글 첨부 파일
이 댓글에 이미지나 파일을 업로드 합니다.
파일 크기는 8 MB보다 작아야 합니다.
허용할 파일 형식: txt pdf doc xls gif jpg jpeg mp3 png rar zip.
CAPTCHA
이것은 자동으로 스팸을 올리는 것을 막기 위해서 제공됩니다.