Ignore:
Timestamp:
03/22/2020 03:52:07 PM (4 years ago)
Author:
Pierre Labastie <pieere@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
Children:
254bc90d
Parents:
dcee7a56
Message:

Format netprogs

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22874 af4574ff-66df-0310-9fd7-8a98e5e911e0

File:
1 edited

Legend:

Unmodified
Added
Removed

  • networking/netprogs/rsync.xml

    rdcee7a56 rb51fe6e  
    3030    <title>Introduction to rsync</title>
    3131
    32     <para>The <application>rsync</application> package contains the
    33     <command>rsync</command> utility. This is useful for synchronizing large
    34     file archives over a network.</para>
     32    <para>
     33      The <application>rsync</application> package contains the
     34      <command>rsync</command> utility. This is useful for synchronizing large
     35      file archives over a network.
     36    </para>
    3537
    3638    &lfs91_checked;
    … …  
    3941    <itemizedlist spacing="compact">
    4042      <listitem>
    41         <para>Download (HTTP): <ulink url="&rsync-download-http;"/></para>
    42       </listitem>
    43       <listitem>
    44         <para>Download (FTP): <ulink url="&rsync-download-ftp;"/></para>
    45       </listitem>
    46       <listitem>
    47         <para>Download MD5 sum: &rsync-md5sum;</para>
    48       </listitem>
    49       <listitem>
    50         <para>Download size: &rsync-size;</para>
    51       </listitem>
    52       <listitem>
    53         <para>Estimated disk space required: &rsync-buildsize;</para>
    54       </listitem>
    55       <listitem>
    56         <para>Estimated build time: &rsync-time;</para>
     43        <para>
     44          Download (HTTP): <ulink url="&rsync-download-http;"/>
     45        </para>
     46      </listitem>
     47      <listitem>
     48        <para>
     49          Download (FTP): <ulink url="&rsync-download-ftp;"/>
     50        </para>
     51      </listitem>
     52      <listitem>
     53        <para>
     54          Download MD5 sum: &rsync-md5sum;
     55        </para>
     56      </listitem>
     57      <listitem>
     58        <para>
     59          Download size: &rsync-size;
     60        </para>
     61      </listitem>
     62      <listitem>
     63        <para>
     64          Estimated disk space required: &rsync-buildsize;
     65        </para>
     66      </listitem>
     67      <listitem>
     68        <para>
     69          Estimated build time: &rsync-time;
     70        </para>
    5771      </listitem>
    5872    </itemizedlist>
    … …  
    7387    <title>Installation of rsync</title>
    7488
    75     <para>For security reasons, running the <application>rsync</application>
    76     server as an unprivileged user and group is encouraged. If you intend to
    77     run <command>rsync</command> as a daemon, create the
    78     <systemitem class="username">rsyncd</systemitem> user and group
    79     with the following commands issued by the
    80     <systemitem class="username">root</systemitem> user:</para>
     89    <para>
     90      For security reasons, running the <application>rsync</application>
     91      server as an unprivileged user and group is encouraged. If you intend to
     92      run <command>rsync</command> as a daemon, create the
     93      <systemitem class="username">rsyncd</systemitem> user and group
     94      with the following commands issued by the
     95      <systemitem class="username">root</systemitem> user:
     96    </para>
    8197
    8298<screen role="root"><userinput>groupadd -g 48 rsyncd &amp;&amp;
    … …  
    84100    -s /bin/false -u 48 rsyncd</userinput></screen>
    85101
    86     <para>Install <application>rsync</application> by running the following
    87     commands:</para>
     102    <para>
     103      Install <application>rsync</application> by running the following
     104      commands:
     105    </para>
    88106
    89107<screen><userinput>./configure --prefix=/usr --without-included-zlib &amp;&amp;
    90108make</userinput></screen>
    91109
    92     <para>If you have <xref linkend="doxygen"/> installed and wish to
    93     build HTML API documentation, issue:</para>
     110    <para>
     111      If you have <xref linkend="doxygen"/> installed and wish to
     112      build HTML API documentation, issue:
     113    </para>
    94114
    95115<screen remap="doc"><userinput>doxygen</userinput></screen>
    96116
    97     <para>To test the results, issue: <command>make check</command>.</para>
    98 
    99     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     117    <para>
     118      To test the results, issue: <command>make check</command>.
     119    </para>
     120
     121    <para>
     122      Now, as the <systemitem class="username">root</systemitem> user:
     123    </para>
    100124
    101125<screen role='root'><userinput>make install</userinput></screen>
    102126
    103     <para>If you built the documentation, install it using the following
    104     commands as the <systemitem class="username">root</systemitem> user:</para>
     127    <para>
     128      If you built the documentation, install it using the following
     129      commands as the <systemitem class="username">root</systemitem> user:
     130    </para>
    105131
    106132<screen role='root'
    … …  
    126152      <title>Config Files</title>
    127153
    128       <para><filename>/etc/rsyncd.conf</filename></para>
     154      <para>
     155        <filename>/etc/rsyncd.conf</filename>
     156      </para>
    129157
    130158      <indexterm zone="rsync rsync-config">
    … …  
    137165      <title>Configuration Information</title>
    138166
    139       <para>For client access to remote files, you may need to install the
    140       <xref linkend="openssh"/> package to connect to the remote server.</para>
    141 
    142       <para>This is a simple download-only configuration to set up running
    143       <command>rsync</command> as a server. See the rsyncd.conf(5)
    144       man-page for additional options (i.e., user authentication).</para>
     167      <para>
     168        For client access to remote files, you may need to install the
     169        <xref linkend="openssh"/> package to connect to the remote server.
     170      </para>
     171
     172      <para>
     173        This is a simple download-only configuration to set up running
     174        <command>rsync</command> as a server. See the rsyncd.conf(5)
     175        man-page for additional options (i.e., user authentication).
     176      </para>
    145177
    146178<screen role="root"><userinput>cat &gt; /etc/rsyncd.conf &lt;&lt; "EOF"
    … …  
    161193EOF</userinput></screen>
    162194
    163     <para>You can find additional configuration information and general
    164     documentation about <command>rsync</command> at
    165     <ulink url="http://rsync.samba.org/documentation.html"/>.</para>
     195      <para>
     196        You can find additional configuration information and general
     197        documentation about <command>rsync</command> at
     198        <ulink url="http://rsync.samba.org/documentation.html"/>.
     199      </para>
    166200
    167201    </sect3>
    … …  
    171205             <phrase revision="systemd">Systemd Unit</phrase></title>
    172206
    173       <para>Note that you only want to start the
    174       <application>rsync</application> server if you want to provide an
    175       <application>rsync</application> archive on your local machine.
    176       You don't need this <phrase revision="sysv">script</phrase>
    177       <phrase revision="systemd">unit</phrase> to run the
    178       <application>rsync</application> client.</para>
    179 
    180       <para>Install the
    181       <phrase revision="sysv"><filename>/etc/rc.d/init.d/rsyncd</filename> init
    182       script</phrase>
    183       <phrase revision="systemd"><filename>rsyncd.service</filename>
    184       unit</phrase> included in the
    185       <xref linkend="bootscripts" revision="sysv"/>
    186       <xref linkend="systemd-units" revision="systemd"/> package.</para>
     207      <para>
     208        Note that you only want to start the
     209        <application>rsync</application> server if you want to provide an
     210        <application>rsync</application> archive on your local machine.
     211        You don't need this <phrase revision="sysv">script</phrase>
     212        <phrase revision="systemd">unit</phrase> to run the
     213        <application>rsync</application> client.
     214      </para>
     215
     216      <para>
     217        Install the
     218        <phrase revision="sysv"><filename>/etc/rc.d/init.d/rsyncd</filename>
     219        init script</phrase>
     220        <phrase revision="systemd"><filename>rsyncd.service</filename>
     221        unit</phrase> included in the
     222        <xref linkend="bootscripts" revision="sysv"/>
     223        <xref linkend="systemd-units" revision="systemd"/> package.
     224      </para>
    187225
    188226<screen role="root"><userinput>make install-rsyncd</userinput></screen>
    189227
    190228      <note revision="systemd">
    191         <para>This package comes with two types of units: A service file and a
    192         socket file. The service file will start rsync daemon once at boot
    193         and it will keep running until the system shuts down. The socket file
    194         will make systemd listen on rsync port (Default 873, needs to be
    195         edited for anything else) and will start rsync daemon when something
    196         tries to connect to that port and stop the daemon when the connection
    197         is terminated. This is called socket activation and is analogous to
    198         using <application>{,x}inetd</application> on a SysVinit based
    199         system.</para>
    200 
    201 
    202         <para>By default, the first method is used - rsync daemon is started
    203         at boot and stopped at shutdown. If the socket method is desired, you
    204         need to run as the
    205         <systemitem class="username">root</systemitem> user:</para>
     229        <para>
     230          This package comes with two types of units: A service file and a
     231          socket file. The service file will start rsync daemon once at boot
     232          and it will keep running until the system shuts down. The socket file
     233          will make systemd listen on rsync port (Default 873, needs to be
     234          edited for anything else) and will start rsync daemon when something
     235          tries to connect to that port and stop the daemon when the connection
     236          is terminated. This is called socket activation and is analogous to
     237          using <application>{,x}inetd</application> on a SysVinit based
     238          system.
     239        </para>
     240
     241        <para>
     242          By default, the first method is used - rsync daemon is started
     243          at boot and stopped at shutdown. If the socket method is desired, you
     244          need to run as the
     245          <systemitem class="username">root</systemitem> user:
     246        </para>
    206247
    207248<screen role="nodump"><userinput>systemctl stop rsyncd &amp;&amp;
    … …  
    210251systemctl start rsyncd.socket</userinput></screen>
    211252
    212         <para>Note that socket method is only useful for remote backups. For
    213         local backups you'll need the service method.</para>
     253        <para>
     254          Note that socket method is only useful for remote backups. For
     255          local backups you'll need the service method.
     256        </para>
    214257      </note>
    215258
    … …  
    241284        <term><command>rsync</command></term>
    242285        <listitem>
    243           <para>is a replacement for <command>rcp</command> (and
    244           <command>scp</command>) that has many more features. It uses the
    245           <quote>rsync algorithm</quote> which provides a very fast method of
    246           syncing remote files. It does this by sending just the differences
    247           in the files across the link, without requiring that both sets of
    248           files are present at one end of the link beforehand.</para>
     286          <para>
     287            is a replacement for <command>rcp</command> (and
     288            <command>scp</command>) that has many more features. It uses the
     289            <quote>rsync algorithm</quote> which provides a very fast method of
     290            syncing remote files. It does this by sending just the differences
     291            in the files across the link, without requiring that both sets of
     292            files are present at one end of the link beforehand.
     293          </para>
    249294          <indexterm zone="rsync rsync-prog">
    250295            <primary sortas="b-rsync">rsync</primary>
Note: See TracChangeset for help on using the changeset viewer.