[docs] Re: docs plans

Anton Farygin rider на altlinux.com
Пн Дек 29 18:25:54 MSK 2003


Anton V. Boyarshinov wrote:
> On Fri, 26 Dec 2003 15:17:30 +0300 Anton Farygin
>  wrote:
> 
>>>>Для примера - у нас есть классный электронный справочник man.
>>>>Попробуйте в нем быстро найти утилиты, с помощью которых
>>>
>>>можно>получить: 1) имя каталога из полного пути к файлу
>>>
>>>>2) количество строк в файле
>>>>3) утилиту, уменьшающую размер текстового файла методом
>>>
>>>замены>пробелов на табуляцию.
>>>
>>>
>>>Первые 2 не интересно -- я знаю ответ. Третье -- элементарно:
>>>
>>>apropos spaces 
>>
>>А где оно описано в документации ???
> 
> 
> Мораль -- должны быть описаны способы доступа к существующей
> электронной документации. С другой стороны -- man описан, стало
> быть и apropos в man man найти несложно.

man(1) 
man(1)

NAME
        man - format and display the on-line manual pages
        manpath - determine user's search path for man pages

SYNOPSIS
        man  [-acdfFhkKtwW]  [--path]  [-m system] [-p string] [-C 
config_file]
        [-M pathlist] [-P pager] [-S section_list] [section] name ...

DESCRIPTION
        man formats and displays the on-line manual pages.  If you 
specify sec-
        tion,  man  only looks in that section of the manual.  name is 
normally
        the name of the manual page, which is typically the name of a 
command,
        function,  or  file.   However,  if  name contains a slash (/) 
then man
        interprets it as a file specification, so that you can do  man 
./foo.5
        or even man /cd/foo/bar.1.gz.

        See  below  for  a  description  of where man looks for the 
manual page
        files
....

тому, кто не знает английский - unreal...

> 
> 
>>>Боюсь даже подумать о том, сколько временибы ушло на поиск в
>>>бумажной книге.
>>
>>Немного ;-)
> 
> 
> Не уверен.
>  
> 
>>К тому же книга отличается от электронного документа тем, что с
>>ней можно работать не имея под рукой комьютера.
>>
>>Что многие и делают.
> 
> 
> ИМХО есть 2 вида документации.
> 
> 1 Описание концепций (описание особенностей дистрибутива тоже
> сюда входит)
> 
> 2 Справочник.
> 
> С первым видом документации можно и нужно общаться без
> компьютера. Со вторым -- практически никогда. Мне никогда не
> приходило в голову почитать man strftime или man 5 crontab на сон
> грядущий. А вот PDF specification -- запросто. 
> 

А использование crontab для управление задачами ?? ;-)
Или вот так: "Управление расписанием выполнения задач в Linux" ?

Rgds,
Rider






Подробная информация о списке рассылки docs