gnunet-auto-share.1 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. .\" This file is part of GNUnet.
  2. .\" Copyright (C) 2001-2019 GNUnet e.V.
  3. .\"
  4. .\" Permission is granted to copy, distribute and/or modify this document
  5. .\" under the terms of the GNU Free Documentation License, Version 1.3 or
  6. .\" any later version published by the Free Software Foundation; with no
  7. .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  8. .\" copy of the license is included in the file
  9. .\" FDL-1.3.
  10. .\"
  11. .\" A copy of the license is also available from the Free Software
  12. .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
  13. .\"
  14. .\" Alternately, this document is also available under the General
  15. .\" Public License, version 3 or later, as published by the Free Software
  16. .\" Foundation. A copy of the license is included in the file
  17. .\" GPL3.
  18. .\"
  19. .\" A copy of the license is also available from the Free Software
  20. .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
  21. .\"
  22. .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23. .\"
  24. .Dd June 18, 2012
  25. .Dt GNUNET-AUTO-SHARE 1
  26. .Os
  27. .Sh NAME
  28. .Nm gnunet-auto-share
  29. .Nd a command line tool to automatically share an entire directory with other users
  30. .Sh SYNOPSIS
  31. .Nm
  32. .Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
  33. .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  34. .Op Fl D | -disable-extractor
  35. .Op Fl d | -disable-creation-time
  36. .Op Fl h | -help
  37. .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  38. .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
  39. .Op Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY
  40. .Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
  41. .Op Fl V | -verbose
  42. .Op Fl v | -version
  43. .Ao Ar DIRNAME Ac
  44. .Sh DESCRIPTION
  45. In order to share files with other GNUnet users, the files must first be made available to GNUnet.
  46. This tool can be used to automatically share all files from a certain directory.
  47. The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
  48. Which files have already been shared is remembered in a
  49. .Pa .auto-share
  50. file in the shared directory.
  51. You can run the tool by hand or automatically by adding the respective options to your configuration.
  52. gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files.
  53. .Pp
  54. You can use automatic meta-data extraction (based on libextractor).
  55. The options are as follows:
  56. .Bl -tag -width indent
  57. .It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
  58. This option can be used to specify additional anonymity constraints.
  59. The default is 1.
  60. If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key.
  61. This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
  62. If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
  63. However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
  64. You can gain better privacy by specifying a higher level of anonymity (using values above 1).
  65. This tells FS that it must hide your own requests in equivalent-looking cover traffic.
  66. This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
  67. However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
  68. The specific numeric value (for anonymity levels above 1) is simple:
  69. Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
  70. The time-period is twice the average delay by which GNUnet artificially delays traffic.
  71. Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
  72. .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  73. Use alternate config file (if this option is not specified, the default is
  74. .Pa ~/.config/gnunet.conf Ns ).
  75. .It Fl D | -disable-extractor
  76. Disable use of GNU libextractor for finding additional keywords and metadata.
  77. .It Fl d | -disable-creation-time
  78. Disable adding the creation time to the metadata of the uploaded file.
  79. .It Fl h | -help
  80. Print a brief help page with all the options.
  81. .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  82. Change the loglevel.
  83. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  84. .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
  85. Configure logging to write logs to FILENAME.
  86. .It Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY
  87. Executive summary: You probably don't need it.
  88. Set the priority of the published content (default: 365).
  89. If the local database is full, GNUnet will discard the content with the lowest ranking.
  90. Note that ranks change over time depending on popularity.
  91. The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
  92. .It Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
  93. Set the desired replication level.
  94. If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) LEVEL times to other peers before doing normal "random" replication of all content.
  95. This option can be used to push some content out into the network harder.
  96. Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
  97. .It Fl V | -verbose
  98. Be verbose.
  99. Using this option causes gnunet-publish to print progress information and at the end the file identification that can be used to download the file from GNUnet.
  100. .It Fl v | -version
  101. Print the version number.
  102. .El
  103. .Sh EXAMPLES
  104. .Ss Basic example
  105. $ gnunet-auto-share $HOME/gnunet-share/ &
  106. .Pp
  107. Share a directory
  108. .Pa $HOME/gnunet-share/
  109. .Ss Basic configuration
  110. $ Share a directory
  111. .Pa $HOME/gnunet-share/
  112. .Pp
  113. .Bd -literal -offset indent -compact
  114. [gnunet-auto-share]
  115. OPTIONS = $HOME/gnunet-share
  116. IMMEDIATE_START = YES # start this service when the peer starts
  117. .Ed
  118. .Sh FILES
  119. .Pa ~/.config/gnunet.conf
  120. GNUnet configuration file
  121. .Sh SEE ALSO
  122. .Xr extract 1 ,
  123. .Xr gnunet-download 1 ,
  124. .Xr gnunet-fs-gtk 1 ,
  125. .Xr gnunet-publish 1 ,
  126. .Xr gnunet-search 1 ,
  127. .Xr gnunet.conf 5
  128. .sp
  129. The full documentation for gnunet is maintained as a Texinfo manual.
  130. If the
  131. .Xr info 1
  132. and gnunet programs are properly installed at your site, the command
  133. .Pp
  134. .Dl info gnunet
  135. .Pp
  136. should give you access to the complete handbook,
  137. .Pp
  138. .Dl info gnunet-c-tutorial
  139. .Pp
  140. will give you access to a tutorial for developers.
  141. .sp
  142. Depending on your installation, this information is also available in
  143. .Xr gnunet 7 and
  144. .Xr gnunet-c-tutorial 7 .
  145. .\".Sh HISTORY
  146. .\".Sh AUTHORS
  147. .Sh BUGS
  148. Report bugs by using
  149. .Lk https://bugs.gnunet.org
  150. or by sending electronic mail to
  151. .Aq Mt gnunet-developers@gnu.org .