본 사용설명서의 모든 내용은 옥타브 명령 doc에도 있습니다. 추가로, 개별 사용자 작성 함수와 변수에 대한 문서도 help 명령에 있습니다. 이 절은 사용설명서와 사용자 제공 함수와 변수에 대한 문서를 읽기 위한 명령어에 대해 설명합니다. 여러분이 작성한 함수에 대한 문서를 작성하는 방법에 대한 더 많은 정보는 함수 기록철에 있습니다.
이름에 대한 도움말을 보여줍니다.
예를 들어, help help 명령은 help 명령어에 대한 짧은 안내를 출력합니다.
단일 매개변수 --list를 주면, 모든 연산자, 예약어, 내장 함수, 현재 옥타브 작업에서 적재 가능한 함수
목록을 가져옵니다.
단일 매개변수 .를 주면, 현재 옥타브 작업에서 적재 가능한 모든 연산자 목록을 가져옵니다.
아무 매개변수 없이 실행하면, help는 명령줄에서 도움말을 불러오는 방법에 대해 설명합니다.
도움말 명령은 연산자 대부분에 대한 정보를 제공하지만, 옥타브가 이름을 개별 명령으로 착각하지 않게 하기 위해 반드시 작은
따옴표나 큰 따옴표로 묶어서 입력해야 합니다. help "+"는 뎃셈 연산자에 대한 도움말을 보여줍니다.
그누 인포 탐색기로 함수명 함수에 대한 출판된 도움말의 정보통신망판을 바로 보여줍니다.
아무 매개변수 없이 실행하면, 사용설명서의 첫 부분이 나옵니다.
doc rand 명령을 내리면, 그누 인포 탐색기는 정보통신망판 사용설명서의 rand장을
보여줍니다.
그누 인포 탐색기가 실행되고 나면, C-h 명령으로도 도움말을 볼 수 있습니다.
같이 보기: help.
함수 탐색 경로에 있는 함수 전체에 관한 문서에서 문자열을 찾습니다.
기본적으로 lookfor은 개별 함수 도움말에서 처음으로 등장하는 문자열을 찾습니다. 개별 함수
도움말 전체에서 찾고 싶다면, 매개변수 "-all"을 사용해야 합니다. 이 명령어는 대소문자 구분을 하지 않습니다.
출력 매개변수 없이 호출하면, lookfor은 찾은 함수 목록을 창에 보여줍니다. 출력 매개변수 있이 호출하면,
출력 매개변수 함수는 함수 이름을 담고, 도움말_첫_명령문은 찾은 각 함수의 도움말 첫 명령문을 담습니다.
풀그림 짜기 안내: lookfor이 도움말 첫 명령문을 정확하게 찾으려면, 도움말 첫 명령문이 함수 도움말 서식에
맞아야 합니다. 모든 옥타브 핵심 함수는 서식에 맞으나, 외부 꾸러미나 사용자 제공 함수는 서식에 맞지 않을 수 있습니다. 따라서
"-all" 매개변수 사용이 옥타브 외부의 관련 함수를 찾는 데에 필요할 수 있습니다.
임시 문서로 탐색 속도의 비약적 증가가 가능합니다. doc_cache_create에 더 많은 정보가 있습니다.
같이 보기: help, doc, which, path, doc_cache_create.
현 옥타브에서 무엇인 새로운지 보려면, 함수 news를 사용합니다.
현재 옥타브 또는 설치된 꾸러미의 NEWS 기록철을 봅니다.
아무 매개변수 없이 호출하면, 현재 옥타브의 NEWS 기록철을 봅니다.
꾸러미에 꾸러미 이름을 입력하면, 해당 꾸러미의 현재 NEWS 기록철을 봅니다.
그누 옥타브 사용자 모임에 들어가는 방법을 안내합니다.
옥타브 복제 및 배포 조건을 기술합니다.
아래 함수는 문서를 보여주는 풀그림을 바꾸거나 문서를 찾는 위치를 바꾸는 데에 사용합니다.
옥타브 인포 기록철 이름을 지정하는 내부 변수를 조회 또는 설정합니다.
octave-home이 옥타브가 설치된 뿌리 자료방일 때에는 octave-home/info/octave.info가
기본값입니다. 환경 변수 OCTAVE_INFO_FILE 또는
명령줄 매개변수 --info-file 기록철명이 기본값에 우선됩니다.
함수 안에 "local" 선택지가 설정되어 호출되면, 변수는 해당 함수와 그 함수가 호출한 아래 경로에서 지역 변수로 바뀝니다. 기존 값은 함수가 종료되면 복구됩니다.
같이 보기: info_program, doc, help, makeinfo_program.
실행할 인포 풀그림 이름을 지정하는 내부 변수를 조회 또는 설정합니다.
octave-home이 옥타브가 설치된 뿌리 자료방일 때에는 octave-home/libexec/octave/판/exec/체제/info가
기본값이며, 판은 옥타브 판 번호이고, 체제는 운영체제 형식(예: i686-pc-linux-gnu)입니다. 환경 변수 OCTAVE_INFO_PROGRAM
또는 명령줄 매개변수 --info-program 이름이 기본값에 우선됩니다.
함수 안에 "local" 선택지가 설정되어 호출되면, 변수는 해당 함수와 그 함수가 호출한 아래 경로에서 지역 변수로 바뀝니다. 기존 값은 함수가 종료되면 복구됩니다.
같이 보기: info_file, doc, help, makeinfo_program.
텍스인포 조판 명령을 포함한 도움말 글월의 서식을 처리하기 위해 옥타브가 실행할 풀그림 이름을 지정하는 내부 변수를 조회 또는 설정합니다.
기본 값은 makeinfo입니다.
함수 안에 "local" 선택지가 설정되어 호출되면, 변수는 해당 함수와 그 함수가 호출한 아래 경로에서 지역 변수로 바뀝니다. 기존 값은 함수가 종료되면 복구됩니다.
같이 보기: texi_macros_file, info_file, info_program, doc, help.
문서가 메이크인포로 처리되기 이전에 선처리해 줄 텍스인포 모듬 명령을 포한한 기록철 이름을 지정하는 내부 변수를 조회 또는 설정합니다.
octave-home이 옥타브가 설치된 뿌리 자료방일 때에는 octave-home/share/octave/판/etc/macros.texi가
기본값이며, 판은 옥타브의 판 번호입니다. 환경 변수
OCTAVE_TEXI_MACROS_FILE 또는 명령줄 매개변수 --texi-macros-file 기록철명이
기본값에 우선됩니다.
함수 안에 "local" 선택지가 설정되어 호출되면, 변수는 해당 함수와 그 함수가 호출한 아래 경로에서 지역 변수로 바뀝니다. 기존 값은 함수가 종료되면 복구됩니다.
같이 보기: makeinfo_program.
옥타브 문서 시렁 기록철의 이름을 지정하는 내부 변수를 조회 또는 설정합니다.
lookfor 명령어의 성능을 비약적으로 향상시켜 주는 시렁 기록철입니다. octave-home이
옥타브가 설치된 뿌리 자료방일 때에는 octave-home/share/octave/판/etc/doc-cache가
기본값이며, 판은 옥타브의 판 번호입니다. 환경 변수
OCTAVE_DOC_CACHE_FILE 또는 명령줄 매개변수 --doc-cache-file 기록철명이
기본값에 우선됩니다.
함수 안에 "local" 선택지가 설정되어 호출되면, 변수는 해당 함수와 그 함수가 호출한 아래 경로에서 지역 변수로 바뀝니다. 기존 값은 함수가 종료되면 복구됩니다.
같이 보기: doc_cache_create, lookfor, info_program, doc, help, makeinfo_program.
같이 보기: lookfor.
내장 옥타브 함수에 대한 문서화를 포함한 기록철의 이름을 지정하는 내부 변수를 조회 또는 설정합니다.
octave-home이 옥타브가 설치된 뿌리 자료방일 때에는 octave-home/share/octave/판/etc/built-in-docstrings가
기본값이며, 판은 옥타브의 판 번호입니다. 환경 변수
OCTAVE_BUILT_IN_DOCSTRINGS_FILE 또는 명령줄 매개변수
--built-in-docstrings-file 기록철명이 기본값에 우선됩니다.
안내: 이 변수는 옥타브 자가 초기화 때만 사용됩니다. 실행 중인 옥타브에서 수정하면 어떠한 영향도 없습니다.
옥타브가 help 명령어 출력 뒤에 덧붙일 추가 도움말, 또는 내장 명령어용 용례 안내를 할지 안할지
제어하는 내부 변수를 조회 또는 설정합니다.
함수 안에 "local" 선택지가 설정되어 호출되면, 변수는 해당 함수와 그 함수가 호출한 아래 경로에서 지역 변수로 바뀝니다. 기존 값은 함수가 종료되면 복구됩니다.
아래 함수는 옥타브가 내부적으로 문서를 생성하는 데에 주요하게 사용합니다. 도움말을 완벽하고, 가끔 사용자가 요긴하게 사용하기에 넣었습니다.
위치 내 전체 함수에 관한 문서 시렁을 생성합니다.
단일 문자열 또는 낱칸 배열인 문자열인 위치에 있는 전체 함수에 관한 문서 시렁을 생성합니다. 시렁은
lookfor 함수 속도를 개선하는 데에 쓰입니다.
시렁은 출력_기록철에 저장되며, 기본 값은 doc-cache입니다.
위치가 지정되지 않거나, 빈 행렬일 때에는 내장 함수, 연산자, 예약어에 관한 시렁을 생성합니다.
같이 보기: doc_cache_file, lookfor, path.
이름 함수에 관한 날도움말 글월을 반환합니다.
날도움말 글월은 글월에 반환되고, 형식은 "texinfo", "html",
또는 "plain text" 중 하나인 문자열입니다.
같이 보기: get_help_text_from_file.
기록철명인 기록철에서 날도움말 글월을 반환합니다.
날도움말 글월은 글월에 반환되고, 형식은 "texinfo", "html",
또는 "plain text" 중 하나인 문자열입니다.
같이 보기: get_help_text.
함수 도움말 글월의 첫 명령문을 반환합니다.
명령문은 함수 선언 뒤부터 마침표(".") 또는 행갈이 두 번("\n\n")까지 있는 글월입니다. 글월은 기본 값아 80인
최대_길이에 맞춰 잘립니다. 내용이 잘리면, 잘린 뒤에도 내용이 있다는 것을 보여주가 위해 마직막 세 글자는 "..."로
대체됩니다.
선택 출력 매개변수인 상태는 메이크인포가 보고한 상태를 반환합니다. 출력 매개변수가 하나만 있고, 상태가 0이 아닐 때에는 경고가 나옵니다.
도움말 글월의 첫 줄 예시입니다.
get_first_help_sentence ("get_first_help_sentence")
-| ans = 함수 도움말 글월의 첫 명령문을 반환합니다.